Installation on Linux

This has been tested on Fedora 27, but for other distribution it's not really much different other than using your distributions package management system instead of dnf when installing postgresql and redis. Note: While this is still in the early stages of development, these instructions will be for using it with Django's built-in server instead of a proper production installation.

Note: If you want to set-up a production instance of Bamf, you can use these instructions. The only thing you would need to do different is git clone bamf instead of creating a new django project, and systemd'ing your huey instance.

Install Postgresql and Redis

1. Run the following commands in Terminal:
   1. Install redis and postgresql: sudo dnf install postgresql-server postgresql-contrib redis
   2. Initialize postgresql: sudo postgresql-setup --initdb --unit postgresql Note: If you're using Ubuntu, you can skip this step.
   3. Start postgresql: sudo systemctl start postgresql
   4. Change to the postgres user: sudo su - postgres
   5. Log into a Postgres session by typing: psql
   6. Create a database for our Django project (substitute something more descriptive than 'myproject'): CREATE DATABASE myproject;
   7. Create a database user which we will use to connect to and interact with the database: CREATE USER myprojectuser WITH PASSWORD 'password';
   8. We are setting the default encoding to UTF-8, which Django expects. We are also setting the default transaction isolation scheme to "read committed", which blocks reads from uncommitted transactions. Lastly, we are setting the timezone. By default, our Django projects will be set to use UTC:
      • ALTER ROLE myprojectuser SET client_encoding TO 'utf8';
      • ALTER ROLE myprojectuser SET default_transaction_isolation TO 'read committed';
      • ALTER ROLE myprojectuser SET timezone TO 'UTC';
   9. Give our database user access rights to the database we created: GRANT ALL PRIVILEGES ON DATABASE myproject TO myprojectuser;
   10. Exit the SQL prompt to get back to the postgres user's shell session: \q
   11. Exit out of the postgres user's shell session to get back to your regular user's shell session: exit

Create the Virtual Environment

1. Run the following commands in Terminal:
   1. Install Virtual Environment: pip install virtualenv
   2. Change to the directory you want install Bamf. For example, if you want to install this in your Documents folder: cd ~/Documents/
   3. Create your virtual environment: virtualenv -p python3 virt
   4. Activate virtual environment: source virt/bin/activate

Install Bamf

1. Download the repository, unarchive it, and rename it to bamf.
2. Copy bamf to the virt directory.
3. Run the following commands in Terminal:
   1. Change into the bamf directory: cd ~/Documents/virt/bamf
   2. Install dependencies: pip install -r requirements.txt
   3. Edit bamf/settings.py, and find the DATABASES section and edit the values for the NAME, USER, PASSWORD, with the information from when you set-up the postgresql database in Section 1.
   4. Generate a secret key (for Django security): python manage.py generatesecretkey
   5. Create your database: python manage.py migrate
   6. Create your admin user: python manage.py createsuperuser
   7. Open a second terminal window and run the following commands:
   8. Change into the virt directory: cd ~/Documents/virt
   9. Activate virtual environment: source virt/bin/activate
   10. Change into the bamf directory: cd ~/Documents/virt/bamf
   11. Start the redis server: sudo systemctl start redis
   12. Start up huey for task management: python manage.py run_huey
   13. Keep redis & huey running!

Get Running!

1. Start your local server: python manage.py runserver
   • For example: python manage.py runserver
2. In your browser, go to http://[YOUR IP ADDRESS]:8000
   • For example: http://192.168.1.30:8000