DemocracyOS Extension Example

This is an example demonstrating how to extend DemocracyOS using Docker.

Getting Started

1. Clone this repo
2. Make sure to have Docker installed on your machine.
3. Copy the file docker-compose.override.yml.example to docker-compose.override.yml, and set the email that you're going to signup with on STAFF. This way you will be able to setup DemocracyOS on the first run.
4. Run DemocracyOS with docker-compose up --build (this could take a while)
5. Go to http://localhost:3000
6. Signup, setup your instance, and that's all :)

Refs

• The file docker-compose.override.yml is added to the .gitignore so it's not uploaded to your Git repo to avoid disclosing any sensitive data or keys.
• If you want to know more about docker-compose, here's the docs: https://docs.docker.com/compose/
• The complete documentation on overriding the default docker-compose.yml can be found here: https://docs.docker.com/compose/extends/
• On your docker-compose.override.yml you can configure DemocracyOS using environment variables. All the available options are here: http://docs.democracyos.org/configuration.html
• The port 27017 is exposed so you can connect to mongo from your machine using any mongo client such as Robomongo.
• All the customized views/endpoints are located on the /ext folder. Following the same folders pattern as DemocracyOS/democracyos.
• New frontend builds, which allows you to use your custom frontend code, are defined here.

Commands

# Spin up your development server with:
docker-compose up

# If you change any dependency you have to re-build your Docker image with:
docker-compose up --build

# Enter to the running DemocracyOS container with:
docker exec -it dos bash

Running on Production

Use as reference the repo DemocracyOS/onpremises. It uses Ansible for provisioning, and Docker Compose to run the server, there you will find more detailed documentation.