How to Run Sefaria With docker-compose

1) Install Docker and Docker Compose

Begin by installing Docker (instructions here) and Docker Compose (instructions here). If you're working with Windows, you might need special support. For further information on this, see the official Docker documentation.

2) Run the project

In your terminal, run the following:

docker-compose up

This will build the project and run it. Once you've run the above, you should have all the proper services set up. The next step is to add some texts.

3) Connect to Mongo and add texts.

Connect to Mongo, running on port 27018. Sefaria uses 27018 instead of the standard port (27017) in order to avoid conflicts with any Mongo instances you may already have running.

Please note: You can find instructions for downloading the Mongo dump below, in section 8.

Once you've connected Mongo, restore the mongodump to the dockerized Mongo instance with the following command:

mongorestore --host localhost:27018

4) Update your local settings file:

Copy the local settings file in the following way:

cp sefaria/local_settings_example.py sefaria/local_settings.py

Once copied, replace the following values:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'sefaria',
        'USER': 'admin',
        'PASSWORD': 'admin',
        'HOST': 'postgres',
        'PORT': '',
    }
}


MONGO_HOST = "db"

You can also replace both the cache values and the respective values in CACHES:

MULTISERVER_REDIS_SERVER = "cache"
REDIS_HOST = "cache"

5) Connect to the Django container and run migrations.

In a new terminal window, run the following:

docker exec -it sefaria-project-web-1 bash

This will connect you to the Django container. Once that has been completed, run the following:

python manage.py migrate

6) Run webpack.

In a new terminal window, run the following:

docker exec -it sefaria-project-node-1 bash

This will connect you to the Django container. Once that has been completed, run either:

    npm run build-client

or

    npm run watch-client

7) Visit the site.

In your browser, navigate to http://localhost:8000

If the server isn't running, you may need to run docker-compose up again.