Revision as of 18:16, 22 June 2015

Configure package repositories

• Add the following apt sources to /etc/apt/sources.list (for Debian 7.x "wheezy"):

deb http://freeside.biz/~ivan/freeside-wheezy/ ./
deb http://freeside.biz/~jeremyd/freeside3-wheezy-stable/ ./

• Run aptitude update.

Install

aptitude install freeside

Database setup

Database User

• Allow the freeside user full access to the freeside database.

with Postgresql:

[ as postgres/pgsql user ]
$ createuser -P freeside 
Enter password for new role: 
Enter it again: 
Shall the new role be a superuser? (y/n) n
Shall the new role be allowed to create databases? (y/n) y
Shall the new role be allowed to create more new roles? (y/n) n

or with MySQL:

$ mysqladmin -u root password 'set_a_root_database_password'
$ mysql -u root -p
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* TO freeside@localhost IDENTIFIED BY 'set_a_freeside_database_password';

Database Access

• Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
  • See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.

Database

• Add the freeside database to your database engine:

with Postgres:

$ su freeside
$ createdb -E UTF8 freeside

or with MySQL:

$ mysqladmin -u freeside -p create freeside 

Bootstrap Freeside

Database

• As the freeside UNIX user, run freeside-setup -d your.domain.name to create the database tables and initial data.

$ su freeside
$ freeside-setup -d example.com

System users

• Create the Freeside system users:

$ su freeside
$ freeside-adduser -g 1 fs_queue
$ freeside-adduser -g 1 fs_daily
$ freeside-adduser -g 1 fs_selfservice
$ freeside-adduser -g 1 fs_api

Employees

• Create one or more Freeside users (your internal sales/tech folks, not customer accounts):

$ su freeside
$ freeside-adduser -g 1 username
$ htpasswd /usr/local/etc/freeside/htpasswd username
Password: 

Additional users can be added using the same command or from the web interface.

Restart freeside

• /etc/init.d/freeside restart

Apache & Web GUI

• Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to freeside
• a2enconf freeside-base
• a2enconf freeside-rt
• chown freeside /var/lock/apache2
• Restart Apache
• The web interface will be available at /freeside

Next steps

• Log into the web interface using the username and password you entered above.
• Proceed to the initial administration of your installation.