Skip to content

Commit

Permalink
docs(SETUP): add basic docker-compose.yml file
Browse files Browse the repository at this point in the history
* set environment, volumes and ports

Contributions for other examples are gracefully accepted.

Signed-off-by: Frederik Zorn <federdaemn@mail.de>
  • Loading branch information
z0rrn committed Sep 23, 2023
1 parent 785edbd commit 92863fb
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,36 @@ SPDX-License-Identifier: Apache-2.0

# Setup

* This is a basic docker-compose.yml to setup anki.
This is a basic docker-compose.yml to setup anki.

```yaml
version: "3.7"

services:

oci-anki-sync:
# https://github.com/federdaemn/oci-anki-sync/blob/main/SETUP.md
image: ghcr.io/federdaemn/oci-anki-sync:2.1.66
container_name: oci-anki-sync
restart: unless-stopped
# these are sample passwords, please change them
environment:
- SYNC_USER1=panda:rsfPz4NXELBxmJ
- SYNC_USER2=penguin:2Qtf5nnsDpsQ3b
volumes:
- oci-anki-sync:/config
ports:
- 22701:22701

volumes:
oci-anki-sync:
```
* the important parts are
* set SYNC_USERX to your desired username and password
* mount volume oci-anki-sync to /config
* open port 22701
**for more configuration options see <https://docs.ankiweb.net/sync-server.html>**
If you know how to configure another reverse-proxy please open an issue/pull request

0 comments on commit 92863fb

Please sign in to comment.