c2b18683d8
* docs(wiki): add new Quickstart to help with using Sync There is a slew of notes that try to explain or show this so a Quickstart can help bring everything into one place. * docs(wiki): combine "First Steps" into single note with relevant links * docs(wiki): update index notes * docs(wiki): fix remaining broken external links * docs(wiki): add core developer How-To guides to orient first-time devs The majority of the documentation is currently spread across several files ins "docs/" and READMEs. Over time these can be consolidated into the wiki while retaining the common CONTRIBUTING.md as a valid entry point. * docs(wiki): add basic guides for plugins and issue integration As with the core development docs, there is too much to add here right now. These notes will serve as a simple entry to other resources. * docs(wiki): add basic reference note for theming * docs(wiki): add basic Translation guide * docs(wiki): rename Theming and linting to clean up headings * docs(wiki): add heading lint exception for GH-specific nav pages; rework sidebar and index pages Sidebar should be a quick-access for the more common topics grouped thematically with the X.00 notes simply enumerating all the notes where appropriate.
1.4 KiB
Run with Docker
How to run the Super Productivity web app in Docker, and how to use the WebDAV integration.
Run the Web App only
docker run -d -p 80:80 super-productivity/super-productivity:latest
Open http://127.0.0.1. The image matches the host platform by default. Use --platform for another architecture (e.g. linux/amd64, linux/arm64, linux/arm/v7).
Data is stored in the browser; the container does not provide persistent storage.
Run with WebDAV
To serve the app and a WebDAV backend from the same host:
-
Copy the repo files to a folder (e.g.
sp/):git clone https://github.com/super-productivity/super-productivity.git mkdir -p sp cp super-productivity/docker-compose.yaml sp/ cp super-productivity/webdav.yaml sp/ cd sp -
Edit
webdav.yaml: set usernames, passwords, and per-user directories under/dataso user data is separate. -
Start the stack:
docker compose pull docker compose up -d -
Open http://127.0.0.1 for the app. In the app, set up sync with WebDAV base URL:
http://127.0.0.1/webdav/.
Other Docker Options
You can pass environment variables to the app container to prefill WebDAV (or other sync) settings on the Settings page. See docker-compose.yaml in the repository for the list of variables.
Related
- 4.23-Managing-Your-Data (sync and backups)
- 2.08-Choose-Sync-Backend