From 7427dfa50f7f1a82aef589f3e6fba8b5b1baa7b0 Mon Sep 17 00:00:00 2001 From: peskyadmin Date: Tue, 3 Jun 2025 20:19:58 -0500 Subject: [PATCH] init manual --- README.md | 47 +++++++++++++++++++++++------------------------ 1 file changed, 23 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 421f25e..908595c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# {{Service}} with Tailscale Integration +# Nextcloud All-in-One with Tailscale Integration -![{{Service}} with Tailscale](https://damconsulting.llc/images/logo_yellow.svg "{{Service}}") +![Nextcloud All-in-One with Tailscale](https://damconsulting.llc/images/logo_yellow.svg "Nextcloud All-in-One") -This project sets up a {{Service}} instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your {{Service}} instance using Tailscale. +This project sets up a Nextcloud All-in-One instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Nextcloud All-in-One instance using Tailscale. ## Prerequisites @@ -12,21 +12,21 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using ## Project Structure ``` -ts-{{service}}/ +nextcloud-aio/ ├── docker-compose.yml ├── tailscale/ │ ├── tailscale-data/ # Persistent Tailscale state │ └── config/ # Tailscale configuration files -└── {{service}}/ - └── config/ # {{Service}} configuration files +└── nextcloud-all-in-one/ + └── config/ # Nextcloud All-in-One configuration files ``` ## Setup Instructions 1. **Clone the Repository** ```bash - git clone https://gitea.damconsulting.llc/DAM/ts-{{service}} - cd ts-{{service}} + git clone https://gitea.damconsulting.llc/DAM/nextcloud-aio + cd nextcloud-aio ``` 2. Create Required Directories ```bash @@ -37,8 +37,8 @@ ts-{{service}}/ - Optionally, update the file in `tailscale/config/serve.json` if you need specific Tailscale serve configurations - CAUTION: Changing `"${TS_CERT_DOMAIN}:443": false` to `true` will expose the service to the internet -4. Configure {{Service}} - - See the [documentation]({{service_docs}}) for configuration options +4. Configure Nextcloud All-in-One + - See the [README in the Repo](https://github.com/nextcloud/all-in-one#nextcloud-all-in-one) for configuration options 5. Start the Services ```bash @@ -48,30 +48,30 @@ ts-{{service}}/ 6. Wait for Certificate to propagate [~2m] 7. Login - - After starting the services your service should be available via tailnet at https://{{service}}.{{YOUR_TAILNET_DOMAIN}}.ts.net ie https://{{service}}.tail12345.ts.net/ + - After starting the services your service should be available via tailnet at https://nextcloud-all-in-one.{{YOUR_TAILNET_DOMAIN}}.ts.net ie https://nextcloud-all-in-one.tail12345.ts.net/ ## Services -### {{service}}-ts (Tailscale) +### nextcloud-all-in-one-ts (Tailscale) - Runs Tailscale VPN client - Image: tailscale/tailscale:latest -- Container name: {{service}}-ts -- Hostname: {{service}} +- Container name: nextcloud-all-in-one-ts +- Hostname: nextcloud-all-in-one - Requires NET_ADMIN and SYS_MODULE capabilities - Persists state in ./tailscale/tailscale-data - Uses configuration from ./tailscale/config -### {{service}} +### nextcloud-all-in-one -- Depends on {{service}}-ts service +- Depends on nextcloud-all-in-one-ts service ## Usage -- After starting the services your service should be available via tailnet at `https://{{service}}.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://{{service}}.tail12345.ts.net/` +- After starting the services your service should be available via tailnet at `https://nextcloud-all-in-one.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://nextcloud-all-in-one.tail12345.ts.net/` - To manually get the Tailscale IP/hostname of your container: ```bash - docker logs {{service}}-ts + docker logs nextcloud-all-in-one-ts ``` Look for the Tailscale IP address in the logs. @@ -90,19 +90,18 @@ ts-{{service}}/ ## Troubleshooting - Check container logs: ```bash - docker logs {{service}}-ts - docker logs {{service}} + docker logs nextcloud-all-in-one-ts + docker logs nextcloud-all-in-one ``` - Ensure your Tailscale auth key is valid and not expired - Verify the configuration files have proper permissions - Make sure required directories exist before starting ## Notes -- The {{Service}} service uses the Tailscale service's network stack via `network_mode: service:{{service}}-ts` +- The Nextcloud All-in-One service uses the Tailscale service's network stack via `network_mode: service:nextcloud-all-in-one-ts` - Direct port mapping is disabled by default as Tailscale handles the networking - Services restart automatically unless explicitly stopped - For more information: - Tailscale documentation: https://tailscale.com/kb/ - - {{Service}} [documentation]({{service_docs}}) - - {{Service}} [repository]({{service_repo}}) - - {{Service}} [linuxserve.io]({{service_lcsr}}) \ No newline at end of file + - Nextcloud All-in-One [documentation](https://nextcloud.com/blog/how-to-install-the-nextcloud-all-in-one-on-linux/) + - Nextcloud All-in-One [repository](https://github.com/nextcloud/all-in-one#nextcloud-all-in-one) \ No newline at end of file