{"id":18984938,"url":"https://github.com/aklajnert/readthedocs-docker","last_synced_at":"2026-04-18T11:03:20.863Z","repository":{"id":53512253,"uuid":"176966204","full_name":"aklajnert/readthedocs-docker","owner":"aklajnert","description":"Docker image to run readthedocs.org on-premise.","archived":false,"fork":false,"pushed_at":"2021-03-26T18:41:41.000Z","size":9894,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-11T11:11:34.474Z","etag":null,"topics":["docker","docker-compose","readthedocs","readthedocs-docker"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aklajnert.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-21T14:50:03.000Z","updated_at":"2021-03-26T18:41:35.000Z","dependencies_parsed_at":"2022-09-12T02:00:18.795Z","dependency_job_id":null,"html_url":"https://github.com/aklajnert/readthedocs-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aklajnert/readthedocs-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aklajnert%2Freadthedocs-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aklajnert%2Freadthedocs-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aklajnert%2Freadthedocs-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aklajnert%2Freadthedocs-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aklajnert","download_url":"https://codeload.github.com/aklajnert/readthedocs-docker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aklajnert%2Freadthedocs-docker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31966218,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","readthedocs","readthedocs-docker"],"created_at":"2024-11-08T16:23:47.949Z","updated_at":"2026-04-18T11:03:20.799Z","avatar_url":"https://github.com/aklajnert.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# readthedocs-docker\n\nDocker image to run readthedocs.org on-premise.\n\n## Running application\n\nThe recommended approach is to use `docker-compose`. It contains full stack necessary to\nrun `readthedocs.org` app including `PostgresSQL` database, `nginx` reverse proxy, `celery` workers, \n`Redis` and the application itself. The project setup is meant to be run with `docker-compose` - standalone\nrun is discouraged.\n\nSimply run `docker-compose up`, and application will start.\n\nFor configuration, suggested approach is to use `docker-compose.override.yml` file. An example file content is shown below:  \n```yaml\nversion: '3'\n\nservices:\n  web:\n    environment:\n      - RTD_ADMIN_USERNAME=rtd-admin\n      - RTD_ADMIN_EMAIL=rtd-admin@example.com\n      - RTD_DOMAIN=\u003cyour-readthedocs-domain\u003e\n  nginx:\n    ports:\n      - 80:8000\n\n```\n\nThe admin account is created only on first startup when database is empty and `RTD_ADMIN_USERNAME` \nenvironment variable is set. The password is autogenerated, it will appear only once in the log.\nLook for a following message in web application logs:  \n```\nCreated admin account with username: \"rtd-admin\" and password: \"\u003crandom-pass\u003e\". Save the password somewhere, as it won't appear again.\n```\n\nSave the password, or change it because as the message says - it won't appear again.\n\nIf you run via docker-compose, in the workdir will be created the `.data` directory. \nThis directory is necessary to preserve database and build images in case if the containers\nwill be removed.\n\n**WARNING!** As mentioned the [official elasticsearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode),\nyou may need to set `vm.max_map_count` in kernel to at least `262144` in order to run ElasticSearch.\n\n## Configuration\n\nThe `docker-compose.yaml` comes with sane defaults allowing you to quickly test the solution,\nbut before deploying into production, you may need to do some setup.\n\nAll the configuration is done via environment variables:\n\n- **RTD_DOMAIN** (`localhost`): domain name of the readthedocs instance,\n- **RTD_ADMIN_USERNAME** (`rtd-admin`) - username for the admin user; this is set in the compose\n    file, no admin account will be created if this variable is missing,\n- **RTD_ADMIN_EMAIL** (`rtd-admin@example.com`) - readthedocs admin e-mail,\n- **RTD_DEBUG** (`False`): run Django in debug mode,\n- **RTD_DB_NAME** (`rtd`): name of the Postgres readthedocs database,\n- **RTD_DB_USER** (`rtd-user`): username for the database,\n- **RTD_DB_PASS** (`rtd-password`): database password,\n- **RTD_DB_HOST** (`db`): hostname with running database,\n- **RTD_SLUMBER_USER** (`slumber`): username for the slumber API; the account will be created\n    if missing,\n- **RTD_SLUMBER_PASS** (`\u003cslumber-password\u003e`): password for slumber API; the slumber account is\n    a superuser account, so you should keep the password secret,\n- **RTD_REDIS_HOST** (`redis`): hostname with running Redis,\n- **RTD_REDIS_PORT** (`6379`): port number to connect with Redis,\n- **RTD_ELASTIC_HOST** (`elasticsearch`): hostname of the Elasticsearch server,\n- **RTD_ELASTIC_PORT** (`9200`): port number for Elasticsearch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faklajnert%2Freadthedocs-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faklajnert%2Freadthedocs-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faklajnert%2Freadthedocs-docker/lists"}