Installation Manual - FER

gasownerData Management

Jan 31, 2013 (4 years and 4 months ago)

110 views





















Course Builder web

Installation Manual


Version

1.0


Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
3



Revision History


Date

Version

Description

Author

2007
-
01
-
13

0.5

Initial Draft

Svebor Prstačić

㈰〷
-

-


1.M

䙩c慬

Svebor Prstačić










䑯挮 乯.W





Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
4



Table of C
ontents

Course Builder web

2

Installation Manual

2

Version 1.0

2

1.

Introduction

5

1.1

Purpose of this document

5

1.2

Document organization

5

1.3

Intended Audience

5

1.4

Scope

5

1.5

Definitions and acronyms

6

1.5.1

Definitions

6

1.5.2

Acronyms and abbreviations

6

1.6

References

6

2.

General requirements

7

2.1

Operating system

7

2.2

Basic technologies

7

2.3

Extensions and add
-
ons

7

2.3.1

Install required

7

2.3.2

Bu
ndled with Course Builder

7

2.4

Web browsers

8

2.5

File upload support (configuration)

8

2.6

Https support (option)

8

3.

Installation procedure

9

3.1

Extracting the course builder

9

3.2

Database creation

9

4.

Post
-

Install Configuration

11

4.1

The web.con
fig file

11

4.1.1

Configuring database connection

11

4.1.2

Configuring SMTP server access

11

4.2

First Run

12

5.

References

13

5.1

List of used technologies with references

13


Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
5



1.

Introduction


1.1

Purpose of this document


T
he purpose of this document is to give the customers the installation instructions on how to install and
configure the
Course Builder web application

in order to

successfully
run on their systems.


1.2

Document organization


The document is organized as follows:



Section 1,
Introduction,

describes contents of this guide,
references to other


related documents

etc.



Section 2,
General Requirements
, describes what operating system, basic technologies and

extension
s

should the system have, in order to run the




Section 4
,
Installation Procedure
, leads the customer through the process of
installation



Section

5
,
Configuring
, shows the customers how to configure Course Builder before putting it to work


1.3

Inten
ded Audience


The intended audience is:



customers, who wish to install and use the
Course Builder



current and future developers, who wish to know how to install it in order to continue working on
developing the
Course Builder



supervisor
s
, who wish to test
the
Course Builder



1.4

Scope


The document will give step by step instructions on how to install the Course Builder and provide a list
of prerequisite software that needs to be installed on the server, for the Course Builder to run.


Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
6



1.5

Definitions and acrony
ms


1.5.1

Definitions


Keyword

Definitions

Web Server

A computer (and the software) on the World Wide Web (connected to the
Internet Backbone) that stores HTML documents that can be retrieved via
a Web browser.

Microsoft Windows

A

free Unix
-
type operating syst
em originally created by Linus Torvalds
with the assistance of developers around the world. Developed under the
GNU General Public
License,

the source code for Linux is freely
available to everyone.

IIS Web Server

A web server that is included in Windows
XP Professional, or Windows
server / NT editions

Session cookies

Client
-
State HTTP Cookies are files containing information about visitors
to a Web site (eg, user name and preferences).


1.5.2

Acronyms and abbreviations


Acronym or

abbreviation

Definitions

I
IS

Internet Information Services

SQL

Structured Query Language

HTTPS

Hype
rText Transfer Protocol, Secure

SSL

Secure Socket Layer

XML

eXtensible Markup Language

HTML

HyperText Markup Language


1.6

References


For all the related documents, see the
Course
Builder

web page on FERWeb DSD home.



Course Builder

Requirements Document



Course Builder

Design Description Document



Course Builder

Technical Documentation



Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
7



2.

General requirements


In this part of the manual the prerequisites to run the Course Builder web
application will be described
.



2.1

Operating system


Course Builder has been developed, tested and designed for Microsoft Windows operating system, and
technologies that it supplies
.

It is might be possible to run it on Linux/Unix operating systems, but peo
ple who really would like to
do that,


2.2

Basic technologies


The following technologies are required to use the
Course Builder



Web Server

o

Suggested is IIS 5.0 or newer version on MS Windows

o

Slight possibility to run it on Apache Web Server on Linux / Unix
(not advised)



ASP.NET 2.0

o




Database server

o

Recommended:
dev
eloped and tested on PostgreSQL version 8.1

o

Should work with other database servers, with the required ODBC drivers installed, and
by configuring the application’s ‘web.config’ file.


This document

will not describe the installation of above products, as we assume that they are already
installed properly.


2.3

Extensions and add
-
ons

For further information on required / installed software listed in this

2.3.1

Install required

Except the basic

technologies, o
ther extensions/add
-
ons
mentioned here
must
be installed

prior to
installing / running Course Builder
:



PostgreSQL ODBC Driver



ASP.NET
:

o

ASP.NET Ajax RC1


2.3.2

Bundled with Course Builder



ASP.NET:

o

ASP.NET Ajax Control Toolkit



General libraries:

Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
8



o

webSupergoo’s ABCp
df libraries for creating / handling of pdf files




2.4

Web browsers


Course Builder

is fully functional in the following stable versions of the browsers:



Mozilla Firefox
1.5

or higher



Internet Explorer 7

or higher



Configuration:

Browsers configuration / fe
atures must be set / support the below list:



accepting session
cookies from the
Course Builder application



JavaScript

enabled



SSL (HTTPS support)

2.5

File upload support (configuration)

The application requires write access to the ‘Files’ directory located ins
ide the application root.

To enable file upload (write support for your application), you need to give the asp worker process
write access to that folder. To achieve that,

-

Find the ‘Files’ directory in your Windows Explorer

-

Right
-
click it, and select pr
operties.

-

Enter the “security” tab, and grant asp write access to that folder.


2.6

Https support (option)

Https support is possible, but it is required that you configure it through your IIS control panel. No
direct support from the application, but it does

work correctly when accessed using https.
Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
9




3.

Installation procedure


A step by step guide

from extraction from archive

to

first

run

of

the Course Builder application will be
presented

in this chapter
.


3.1

Extracting the
course builder

The Course Builder comes
packed in a zip archive. It is required to extract the contents of that archive
to the desired folder. The target folder will probably be the same as target of the IIS’s virtual folder in
which you want to install the application.

To unpack a zip archive,
use your archiving software, or the windows’ built
-
in zip support. To unpack
the archive using Windows’ built
-
in zip support, double
-
click the archive, select all files, and click
“Extract all files” from the “Folder tasks” on the left side of the window.
When asked select the
corresponding destination folder.

3.2

Database
creation

To create the database for the Course Builder application,
a file with sql commands is supplied. It is
necessary to run those commands through your database interface. Be it GUI, som
e sort of console is
irrelevant.

For example, is you are using PostgreSQL in windows, and have PgAdmin installed, fire it up, connect
to your database, open the SQL editor

using the button shown on the image below
.


From the editor, open the file mentio
ned, and execute the commands

using the “Execute query” button
.

The file is called “InstallDB.sql”, and is located in the root folder of the application.

The image below shows sql editor with the mentioned file loaded, and the “Execute query” button
highl
ighted.

The commands supplied do not create nothing more than tables for the application, and the default
administrator user.

So be sure to create a database user

that the application will use,
when accessing the database, and

create

the tables

(run the
sql file) as that user
from pgAdmin or some other
database shell / GUI
.

Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
10




If everything goes well, and no error is reported, it is recommended to delete that
SQL
file for security
purposes.

Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
11




4.

Post
-

Install
Configur
ation

Before first run, it is required to

enter a few settings for the application to use. Settings that should be
provided for the application to fully work are: address of the database server; username and password
for the database user; address of the smtp server.

4.1

The web.config file


The web.
config is a XML file. It contains all the default settings values that are loaded and applied
every time the application starts. Application is restarted every time a web server is restarted, an
upgrade or bug fix is applied, or it is explicitly restarted
from the IIS control panel.

4.1.1

Configuring database connection

There are a few fields in the file that have to be filled with data that lets the application connect to the
database server.

The default way to connect to the database


a PostgreSQL server is b
y entering the correct parts of the
connection string that is in the
web.config file.

4.1.1.1

Connecting to PostgreSQL by default

In the web.config file, locate the line that starts with “
<
add

key
=
"
ConStr
" “

what that line
defines is a connection string to connec
t to PostgreSQL. You need to change parts of the connection
string to match you database access information:
database address, username and password
.

Below is a part of the file you have to modify. The data that is to be entered is written in bold italic
letters.

<
add

key
=
"
ConStr
"

value
=
"
Driver={PostgreSQL Unicode};
database=
nameOfDatabase
;

server=
databaseAddress
;

uid=
username
;

password=
DatabasePassword;

...

Modify only the italic bold words, and leave the rest as it is.

4.1.1.2

Using a DSN

You can also use a D
ata Source Name to connect to the database.

To use a DSN, you have to modify the line in web.config that starts with.


<
add

key
=
"
ConStr
" “

Change the line to look like example below, providing the DSN (name) you created.

<
add

key
=
"
ConStr
"

value
=
"
DSN={
Y
ourDSNName
}
>

Creating a DSN will not be described here, as it falls into OS / Server administration.

4.1.1.3

Using a custom Connection string

To use a custom connection string, you have to modify the line in web.config that starts with


<
add

key
=
"
ConStr
" “

Repla
ce the part that says YourConnectionString with your connection string (example below).

<
add
key
=
"
ConStr
"
value
=
"
DSN={
YourConnectionString
}>

4.1.2

Configuring SMTP server access

For the application to be able to send email notifications and/or other information
to users, you need to
fill some data into the web.config file.

Find a line that looks like the one below:

<
add

key
=
"
SMTPServer
"

value
=
"
smtp.host.mine
"
/>

Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
12



And replace the “smtp.host.mine” with the address of your SMTP server. For example “localhost”.


4.2

Firs
t Run


If you have looked into the SQL file that creates database tables, you might have noticed it also adds
one user to the tables. That user is the first administrator user of the Course Builder. It enables you to
log onto the application after install.

So, to log onto your application for the first time, enter the address of the application into your web
browser. A log
-
in screen will appear. Enter the required data like below.



User name:

admin



Password:

admin

If the

application shows you the “My cours
es” page, you have successfully installed the Course
Builder.

It is strongly recommended

to immediately change your
administrator’s password. To do that, click
the “My Details” button on the top of the screen.

Course Builder


Version: 1.0

Installation Manual


Date: 2007
-
01
-
19





Page
13




5.

References


5.1

List of used technologies with

references




IIS
:
http://www.iis.net



ASP.NET:
http://www.asp.net/

o

ASP.NET Ajax
:
http://ajax.asp.net

o

ASP.NET Ajax Control Toolkit
:

http://ajax.asp.net/default.aspx?tabid=47&subtabid=477




PostgreSQL
8
.
1
:
http://www.postgresql.org/

o

PostgreSQL ODBC driver:
http://www.postgresql.org/ftp/odbc/versions/



weSupergoo ABCpdf

:
http://www.websupergoo.com/abcpdf
-
1.htm