diff --git a/README.md b/README.md index d150864..0591992 100644 --- a/README.md +++ b/README.md @@ -391,6 +391,7 @@ A [wiki](https://en.wikipedia.org/wiki/Wiki) is a publication collaboratively ed - [HedgeDoc](examples/hedgedoc) - HedgeDoc lets you create real-time collaborative markdown notes. - [Docmost](examples/docmost) - Docmost is an open source collaborative documentation and wiki software. It is an open-source alternative to the likes of Confluence and Notion. - [Atlassian Confluence](examples/atlassian-jira-confluence) - Confluence is a wiki solution built for business teams. +- [Siyuan](examples/siyuan) - A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang. ### Money, Budgeting & Management diff --git a/examples/siyuan/.env b/examples/siyuan/.env new file mode 100644 index 0000000..caee29c --- /dev/null +++ b/examples/siyuan/.env @@ -0,0 +1,7 @@ +TZ=Europe/Berlin +PUID=1000 +PGID=1000 + +# please create a random secret +# openssl rand -base64 12 +AuthCode=ExampleSecretKey diff --git a/examples/siyuan/README.md b/examples/siyuan/README.md new file mode 100644 index 0000000..03e08b8 --- /dev/null +++ b/examples/siyuan/README.md @@ -0,0 +1,3 @@ +# References + +- https://github.com/siyuan-note/siyuan diff --git a/examples/siyuan/docker-compose.yml b/examples/siyuan/docker-compose.yml new file mode 100644 index 0000000..2cf34b6 --- /dev/null +++ b/examples/siyuan/docker-compose.yml @@ -0,0 +1,30 @@ +services: + + siyuan: + image: b3log/siyuan:latest + container_name: siyuan + command: ['--workspace=/siyuan/workspace/', '--accessAuthCode=${AuthCode:-S3cr3t}'] + ports: + - 6806:6806/tcp # web ui + expose: + - 6806 + volumes: + - ${DOCKER_VOLUME_STORAGE:-/mnt/docker-volumes}/siyuan/workspace:/siyuan/workspace + restart: unless-stopped + environment: + - TZ=${PUID:-Europe/Berlin} + - PUID=${PUID:-1000} + - PGID=${PGID:-1000} + #networks: + # - proxy + #labels: + # - traefik.enable=true + # - traefik.docker.network=proxy + # - traefik.http.routers.siyuan.rule=Host(`wiki.example.com`) + # - traefik.http.services.siyuan.loadbalancer.server.port=6806 + # # Optional part for traefik middlewares + # - traefik.http.routers.siyuan.middlewares=local-ipwhitelist@file + +#networks: +# proxy: +# external: true \ No newline at end of file