Installation

Basic (Local) Installation

  1. Install Docker per the Docker instructions for your platform.

  2. Download the latest release of Osler either with git:

    $ git clone https://github.com/oslerproject/osler.git
    $ git checkout v2.1.0
    

    or as a zip:

    $ wget https://github.com/oslerproject/osler/archive/v2.1.0.tar.gz
    $ tar -xvzf v2.1.0.tar.gz
    
  3. Build the docker containers (this could take a while):

    $ docker-compose -f local.yml build
    
  4. Create a superuser for yourself:

    $ docker-compose -f local.yml run --rm django python manage.py createsuperuser
    Starting postgres         ... done
    Starting osler_selenium_1 ... done
    Creating osler_django_run ... done
    PostgreSQL is available
    Username: osleruser
    Email address: contact@oslerproject.net
    Password:
    Password (again):
    Superuser created successfully.
    
  5. Run the docker containers

    $ docker-compose -f local.yml up
    [...]
    django      | Django version 3.1.2, using settings 'config.settings.local'
    django      | Development server is running at http://0.0.0.0:8000/
    django      | Using the Werkzeug debugger (http://werkzeug.pocoo.org/)
    django      | Quit the server with CONTROL-C.
    
  6. Visit the development URL (http://0.0.0.0:8000/) in the browser

Production Installation

As above, except use a production Docker compose file for all docker-compose invocations.

$ docker-compose -f production.yml build
$ docker-compose -f production.yml run --rm django python manage.py createsuperuser
$ docker-compose -f production.yml up