thadk / documentcloud

DocumentCloud's back end source code - Please report bugs, issues and feature requests to [e-mail]

DocumentCloud

Analyze, Annotate, Publish. Turn documents into data.

Install

Software required

1. docker
2. docker-compose
3. python
4. invoke

Installation Steps

1. Check out the git repository - git clone [e-mail]:MuckRock/documentcloud.git
2. Enter the directory - cd documentcloud
3. Run the dotenv initialization script - python initialize_dotenvs.py This will create files with the environment variables needed to run the development environment.
4. Start the docker images - inv up This will build and start all of the docker images using docker-compose. It will bind to port 80 on localhost, so you must not have anything else running on port 80. The invoke tasks specify the local.yml configuration file for docker-compose. If you would like to run docker-compose commands directly, set the environment variable export COMPOSE_FILE=local.yml.
5. Set api.dev.documentcloud.org and minio.documentcloud.org to point to localhost - sudo echo "127.0.0.1 api.dev.documentcloud.org minio.documentcloud.org" >> /etc/hosts
6. Enter api.dev.documentcloud.org/ into your browser - you should see the Django API root page.
7. Install and run Squarelet and the DocumentCloud frontend following the instructions in their repos to view the full-stack application.