diff --git a/README.md b/README.md index 48895e9..eff246a 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,7 @@ If you would like to add a new config, you can use the [service-template](templa | 🧠 **LanguageTool** | An open-source proofreading software for multiple languages. | [Details](services/languagetool) | | 🔖 **Linkding** | A self-hosted bookmark manager to save and organize links. | [Details](services/linkding) | | 📥 **Mattermost** | A self-hosted collaborative workflow and communication tool. | [Details](services/mattermost) | +| 📝 **Memos** | A lightweight, self-hosted note-taking and knowledge management platform for capturing ideas, daily notes, and personal knowledge. | [Details](services/memos) | | 📝 **Nanote** | A lightweight, self-hosted note-taking app with Markdown support. | [Details](services/nanote) | | ☁️ **NextCloud** | A suite of client-server software for creating and using file hosting services. | [Details](services/nextcloud) | | 🔗 **Pingvin Share** | **PROJECT ARCHIVED** A self-hosted file sharing platform. | [Details](services/pingvin-share) | diff --git a/services/memos/.env b/services/memos/.env new file mode 100644 index 0000000..73db7cb --- /dev/null +++ b/services/memos/.env @@ -0,0 +1,17 @@ +#version=1.1 +#URL=https://github.com/tailscale-dev/ScaleTail +#COMPOSE_PROJECT_NAME= # Optional: only use when running multiple deployments on the same infrastructure. + +# Service Configuration +SERVICE=memos # Service name (e.g., adguard). Used as hostname in Tailscale and for container naming (app-${SERVICE}). +IMAGE_URL=neosmemo/memos:stable # Docker image URL from container registry (e.g., adguard/adguard-home). + +# Network Configuration +SERVICEPORT=5230 # Port to expose to local network. Uncomment the "ports:" section in compose.yaml to enable. +DNS_SERVER=9.9.9.9 # Preferred DNS server for Tailscale. Uncomment the "dns:" section in compose.yaml to enable. + +# Tailscale Configuration +TS_AUTHKEY= # Auth key from https://tailscale.com/admin/authkeys. See: https://tailscale.com/kb/1085/auth-keys#generate-an-auth-key for instructions. + +# Optional Service variables +# PUID=1000 \ No newline at end of file diff --git a/services/memos/README.md b/services/memos/README.md new file mode 100644 index 0000000..ac88484 --- /dev/null +++ b/services/memos/README.md @@ -0,0 +1,24 @@ +# Memos with Tailscale Sidecar Configuration + +This Docker Compose configuration sets up **Memos** with a Tailscale sidecar container, allowing you to securely access your personal knowledge base over your private Tailnet without exposing it to the public internet. + +## Memos + +[Memos](https://github.com/usememos/memos) is a lightweight, open-source note-taking and knowledge management platform designed for capturing quick thoughts, ideas, and daily logs. It combines the simplicity of a personal notebook with the structure of a self-hosted knowledge base, making it ideal for developers, operators, and individuals who want full control over their notes. + +By pairing Memos with Tailscale, you ensure that your notes remain private and accessible only to authorized devices on your Tailnet, eliminating the need for public exposure or complex reverse proxy setups. + +## Configuration Overview + +In this setup, the `tailscale-memos` service runs Tailscale and manages secure networking. The `memos` service uses the Tailscale network stack via Docker's `network_mode: service:tailscale-memos` configuration. This ensures that Memos is only accessible through your Tailnet unless you explicitly expose ports. + +## Files to check + +Please verify the following before starting: + +- `.env` // Must include `TS_AUTHKEY` for Tailscale authentication + +## Resources + +- Official Repository: +- Documentation: diff --git a/services/memos/compose.yaml b/services/memos/compose.yaml new file mode 100644 index 0000000..5101d2a --- /dev/null +++ b/services/memos/compose.yaml @@ -0,0 +1,70 @@ +configs: + ts-serve: + content: | + {"TCP":{"443":{"HTTPS":true}}, + "Web":{"$${TS_CERT_DOMAIN}:443": + {"Handlers":{"/": + {"Proxy":"http://127.0.0.1:5230"}}}}, + "AllowFunnel":{"$${TS_CERT_DOMAIN}:443":false}} + +services: +# Make sure you have updated/checked the .env file with the correct variables. +# All the ${ xx } need to be defined there. + # Tailscale Sidecar Configuration + tailscale: + image: tailscale/tailscale:latest # Image to be used + container_name: tailscale-${SERVICE} # Name for local container management + hostname: ${SERVICE} # Name used within your Tailscale environment + environment: + - TS_AUTHKEY=${TS_AUTHKEY} + - TS_STATE_DIR=/var/lib/tailscale + - TS_SERVE_CONFIG=/config/serve.json # Tailscale Serve configuration to expose the web interface on your local Tailnet - remove this line if not required + - TS_USERSPACE=false + - TS_ENABLE_HEALTH_CHECK=true # Enable healthcheck endpoint: "/healthz" + - TS_LOCAL_ADDR_PORT=127.0.0.1:41234 # The : for the healthz endpoint + #- TS_ACCEPT_DNS=true # Uncomment when using MagicDNS + - TS_AUTH_ONCE=true + configs: + - source: ts-serve + target: /config/serve.json + volumes: + - ./config:/config # Config folder used to store Tailscale files - you may need to change the path + - ./ts/state:/var/lib/tailscale # Tailscale requirement - you may need to change the path + devices: + - /dev/net/tun:/dev/net/tun # Network configuration for Tailscale to work + cap_add: + - net_admin # Tailscale requirement + #ports: + # - 0.0.0.0:${SERVICEPORT}:${SERVICEPORT} # Binding port ${SERVICE}PORT to the local network - may be removed if only exposure to your Tailnet is required + # If any DNS issues arise, use your preferred DNS provider by uncommenting the config below + #dns: + # - ${DNS_SERVER} + healthcheck: + test: ["CMD", "wget", "--spider", "-q", "http://127.0.0.1:41234/healthz"] # Check Tailscale has a Tailnet IP and is operational + interval: 1m # How often to perform the check + timeout: 10s # Time to wait for the check to succeed + retries: 3 # Number of retries before marking as unhealthy + start_period: 10s # Time to wait before starting health checks + restart: always + + # ${SERVICE} + application: + image: ${IMAGE_URL} # Image to be used + network_mode: service:tailscale # Sidecar configuration to route ${SERVICE} through Tailscale + container_name: app-${SERVICE} # Name for local container management + environment: + MEMOS_PORT: 5230 + MEMOS_DRIVER: sqlite + MEMOS_INSTANCE_URL: https://memos..ts.net # Update with your Tailscale domain + volumes: + - ./${SERVICE}-data:/var/opt/memos + depends_on: + tailscale: + condition: service_healthy + healthcheck: + test: ["CMD", "wget", "--spider", "-q", "http://127.0.0.1:5230"] # Check if ${SERVICE} process is running + interval: 1m # How often to perform the check + timeout: 10s # Time to wait for the check to succeed + retries: 3 # Number of retries before marking as unhealthy + start_period: 30s # Time to wait before starting health checks + restart: always \ No newline at end of file