{"id":13314133,"url":"https://github.com/BoxingOctopus/joplin-server-docker-compose","last_synced_at":"2025-03-10T20:33:27.699Z","repository":{"id":204762237,"uuid":"359068196","full_name":"BoxingOctopus/joplin-server-docker-compose","owner":"BoxingOctopus","description":"A Docker Compose Workflow for deploying Joplin Server, the file sync web service for Joplin, a notebook/notetaking application","archived":false,"fork":false,"pushed_at":"2022-11-11T18:45:11.000Z","size":6,"stargazers_count":5,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-07-29T19:05:45.476Z","etag":null,"topics":["certbot","docker","docker-compose","joplin","nginx","postgresql"],"latest_commit_sha":null,"homepage":"","language":null,"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/BoxingOctopus.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,"governance":null}},"created_at":"2021-04-18T06:53:45.000Z","updated_at":"2023-01-30T00:03:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"680bbf9c-7728-4279-939d-54c559f8c760","html_url":"https://github.com/BoxingOctopus/joplin-server-docker-compose","commit_stats":null,"previous_names":["boxingoctopus/joplin-server-docker-compose"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BoxingOctopus%2Fjoplin-server-docker-compose","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BoxingOctopus%2Fjoplin-server-docker-compose/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BoxingOctopus%2Fjoplin-server-docker-compose/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BoxingOctopus%2Fjoplin-server-docker-compose/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BoxingOctopus","download_url":"https://codeload.github.com/BoxingOctopus/joplin-server-docker-compose/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242922021,"owners_count":20207139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["certbot","docker","docker-compose","joplin","nginx","postgresql"],"created_at":"2024-07-29T18:11:01.976Z","updated_at":"2025-03-10T20:33:27.689Z","avatar_url":"https://github.com/BoxingOctopus.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker Compose Workflow for Joplin Server\r\n\r\n## Table of Contents\r\n\r\n- [About](#about)\r\n- [Getting Started](#getting_started)\r\n- [Notes](#notes)\r\n\r\n## About \u003ca name = \"about\"\u003e\u003c/a\u003e\r\n\r\n[Joplin](https://joplinapp.org) is an open-source note-taking/notebook app which allows synchronization of notebook data to a number of various sources, including its own self-hosted web service. This then, is a [Docker Compose](https://docs.docker.com/compose/) workflow which can be used to deploy Joplin Server as a stack of microservices (Joplin Server, PostgreSQL, Caddy).\r\n\r\n## Getting Started \u003ca name = \"getting_started\"\u003e\u003c/a\u003e\r\n\r\nThis workflow is meant to be deployed remotely, through the use of Docker Contexts, the set up for which is shown below.\r\n\r\n### Prerequisites\r\n\r\n* Docker\r\n* Docker Compose\r\n\r\n### Production Deployment\r\n\r\n1. Clone this repo onto the machine you'll be deploying Joplin onto.\r\n2. Set up your deployment target as a Docker Context:\r\n\r\n```bash\r\ndocker context create joplin-prod \\\r\n    --default-stack-orchestrator=swarm \\\r\n    --docker host=ssh://\u003cuser\u003e@\u003chost\u003e\r\n```\r\n\r\n3. Fill out the details in `./environment/joplin.env`\r\n3. Update the `server_name` directives along with the paths to the Certbot-issued SSL information in the included Nginx config file (`./nginx/joplin.conf`) with the correct hostname.\r\n4. Once all these options are set, bring up the service stack using the following command:\r\n\r\n```bash\r\nDOCKER_CONTEXT=joplin-prod POSTGRES_PASSWD=\u003cpassword\u003e docker-compose up -d\r\n```\r\n\r\n### Development\r\n\r\n\u003e NOTE: All the steps for Development are the same except for the following:\r\n\r\n1. Use the default local docker context instead of the remote one\r\n2. Change the `ENVIRONMENT` variable in `./config/joplin.env` to `development`\r\n3. Deploy the stack using the following command:\r\n\r\n```bash\r\nPOSTGRES_PASSWD=\u003cpassword\u003e\r\n```\r\n\r\n## Notes\r\n\r\n* For more information on Docker Contexts, check [the official documentation](https://docs.docker.com/engine/context/working-with-contexts/)\r\n\r\n* This deployment stack is also published as a Docker App on Docker Hub (TODO)\r\n\r\n* the development","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBoxingOctopus%2Fjoplin-server-docker-compose","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBoxingOctopus%2Fjoplin-server-docker-compose","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBoxingOctopus%2Fjoplin-server-docker-compose/lists"}