diff --git a/README.md b/README.md index d085382..a5644f5 100644 --- a/README.md +++ b/README.md @@ -131,6 +131,7 @@ ScaleTail provides ready-to-run [Docker Compose](https://docs.docker.com/compose | ✅ **DumbDo** | A self-hosted, minimalistic task manager for simple to-do lists. | [Details](services/dumbdo) | | ✅ **Eigenfocus** | A self-hosted task and project management tool for productivity. | [Details](services/eigenfocus) | | 📝 **Excalidraw** | A virtual collaborative whiteboard tool. | [Details](services/excalidraw) | +| 🗂️ **Filebrowser** | A file managing interface within a specified directory, it can be used to upload, delete, preview and edit your files. | [Details](services/filebrowser)| | 📝 **Flatnotes** | A simple, self-hosted note-taking app using Markdown files. | [Details](services/flatnotes) | | 👨🏼‍💻 **Forgejo** | A community-driven, self-hosted Git service. | [Details](services/forgejo) | | 👨🏼‍💻 **Gitea** | A lightweight, self-hosted Git service with repository hosting, pull requests, and issue tracking. | [Details](services/gitea) | @@ -270,20 +271,23 @@ A huge thank you to all our contributors! ScaleTail wouldn’t be what it is tod - - ChillBill77 + + michaelhodges
- ChillBill77 + michaelhodges - - michaelhodges +<<<<<<< HEAD +======= + + ChillBill77
- michaelhodges + ChillBill77 +>>>>>>> b29e62489c77f5a116e616a456296a72de3c92d6 adamsthws
diff --git a/services/filebrowser/.env b/services/filebrowser/.env new file mode 100644 index 0000000..fd58305 --- /dev/null +++ b/services/filebrowser/.env @@ -0,0 +1,20 @@ +#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=filebrowser # Service name (e.g., adguard). Used as hostnme in Tailscale and for ctainer naming (app-${SERVICE}). +IMAGE_URL=filebrowser/filebrowser:s6 # Docker image URL from container registry (e.g., adguard/adguard-home). + +# Network Configuration +SERVICEPORT=80 # 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. + +# Time Zone setting for containers +TZ=Europe/Amsterdam # See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones + +# Optional Service variables +# PUID=1000 diff --git a/services/filebrowser/README.md b/services/filebrowser/README.md new file mode 100644 index 0000000..4fc7f0a --- /dev/null +++ b/services/filebrowser/README.md @@ -0,0 +1,21 @@ +# Filebrowser with Tailscale Sidecar Configuration + +This Docker Compose configuration sets up [Filebrowser](https://filebrowser.org/index.html) with Tailscale as a sidecar container to keep the app reachable over your Tailnet. + +## Filebrowser + +[Filebrowser](https://filebrowser.org/index.html) File Browser provides a file managing interface within a specified directory and it can be used to upload, delete, preview and edit your files. It is a create-your-own-cloud-kind of software where you can just install it on your server, direct it to a path and access your files through a nice web interface. + +## Configuration Overview + +In this setup, the `tailscale-Filebrowser` service runs Tailscale, which manages secure networking for Filebrowser. The `Filebrowser` service utilizes the Tailscale network stack via Docker's `network_mode: service:` configuration. This keeps the app Tailnet-only unless you intentionally expose ports. + +## What to document for users + +- The automatically generated password for the user admin is only displayed once when the container first runs. If you fail to remember it, you will need to manually delete the database and start File Browser again. + +## Files to check + +Please check the following contents for validity as some variables need to be defined upfront. + +- `.env` // Main variable `TS_AUTHKEY` diff --git a/services/filebrowser/compose.yml b/services/filebrowser/compose.yml new file mode 100644 index 0000000..cb794bf --- /dev/null +++ b/services/filebrowser/compose.yml @@ -0,0 +1,71 @@ +configs: + ts-serve: + content: | + {"TCP":{"443":{"HTTPS":true}}, + "Web":{"$${TS_CERT_DOMAIN}:443": + {"Handlers":{"/": + {"Proxy":"http://127.0.0.1:80"}}}}, + "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 + # 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 + + application: + image: ${IMAGE_URL} + network_mode: service:tailscale + container_name: app-${SERVICE} + depends_on: + tailscale: + condition: service_healthy + healthcheck: + test: ["CMD", "pgrep", "-f", "${SERVICE}"] # 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 + volumes: + - ./${SERVICE}-data:/srv + - ./${SERVICE}-database:/database + - ./${SERVICE}-config:/config + environment: + - PUID=1000 + - PGID=1000 + - TZ=${TZ}