DAM/ts-adguard
1
0
Fork 0
generated from DAM/ts-TEMPLATE
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

init

Browse Source
This commit is contained in:
peskyadmin 2025-04-08 22:16:07 -05:00
parent 1c8f2c699c
commit 2345c86007
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -1,8 +1,8 @@
# {{Service}} with Tailscale Integration # Adguard with Tailscale Integration
![{{Service}} with Tailscale](https://jellyfin.org/images/logo.svg "{{Service}}") ![Adguard with Tailscale](https://github.com/AdguardTeam/AdGuardHome/raw/master/doc/adguard_home_darkmode.svg "AdGuard Home")
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 Adguard instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Adguard instance using Tailscale.
## Prerequisites ## Prerequisites
@ -12,33 +12,34 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using
## Project Structure ## Project Structure
``` ```
ts-{{service}}/ ts-adguard/
├── docker-compose.yml ├── docker-compose.yml
├── tailscale/ ├── tailscale/
│ ├── tailscale-data/ # Persistent Tailscale state │ ├── tailscale-data/ # Persistent Tailscale state
│ └── config/ # Tailscale configuration files │ └── config/ # Tailscale configuration files
└── {{service}}/ └── adguard/
└── config/ # {{service}} configuration files ├── conf/ # adguard configuration files
└── work/ # adguard state files
``` ```
## Setup Instructions ## Setup Instructions
1. **Clone the Repository** 1. **Clone the Repository**
```bash ```bash
git clone https://gitea.damconsulting.llc/DAM/ts-{{service}} git clone https://gitea.damconsulting.llc/DAM/ts-adguard
cd ts-{{service}} cd ts-adguard
``` ```
2. Create Required Directories 2. Create Required Directories
```bash ```bash
mkdir -p tailscale/tailscale-data mkdir -p tailscale/tailscale-data adguard/conf adguard/work
``` ```
3. Configure Tailscale 3. Configure Tailscale
- Replace `{{YOUR_TAILSCALE_AUTHKEY}}` in the docker-compose.yml with your actual Tailscale auth key - Replace `{{YOUR_TAILSCALE_AUTHKEY}}` in the docker-compose.yml with your actual Tailscale auth key
- Optionally, update the file in `tailscale/config/serve.json` if you need specific Tailscale serve configurations - 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 - CAUTION: Changing `"${TS_CERT_DOMAIN}:443": false` to `true` will expose the service to the internet
4. Configure {{Service}} 4. Configure Adguard **OPTIONAL**
- See {{service_docs}} for configuration options - See https://adguard-dns.io/kb/adguard-home/getting-started/ for configuration options
5. Start the Services 5. Start the Services
```bash ```bash
@ -51,26 +52,26 @@ ts-{{service}}/
## Services ## Services
### {{service}}-ts (Tailscale) ### adguard-ts (Tailscale)
- Runs Tailscale VPN client - Runs Tailscale VPN client
- Image: tailscale/tailscale:latest - Image: tailscale/tailscale:latest
- Container name: {{service}}-ts - Container name: adguard-ts
- Hostname: {{service}} - Hostname: adguard
- Requires NET_ADMIN and SYS_MODULE capabilities - Requires NET_ADMIN and SYS_MODULE capabilities
- Persists state in ./tailscale/tailscale-data - Persists state in ./tailscale/tailscale-data
- Uses configuration from ./tailscale/config - Uses configuration from ./tailscale/config
### {{service}} ### adguard
- Depends on {{service}}-ts service - Depends on adguard-ts service
## Usage ## 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://adguard.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://adguard.tail12345.ts.net/`
- To manually get the Tailscale IP/hostname of your container: - To manually get the Tailscale IP/hostname of your container:
```bash ```bash
docker logs {{service}}-ts docker logs adguard-ts
``` ```
Look for the Tailscale IP address in the logs. Look for the Tailscale IP address in the logs.
@ -93,19 +94,18 @@ ts-{{service}}/
## Troubleshooting ## Troubleshooting
- Check container logs: - Check container logs:
```bash ```bash
docker logs {{service}}-ts docker logs adguard-ts
docker logs {{service}} docker logs adguard
``` ```
- Ensure your Tailscale auth key is valid and not expired - Ensure your Tailscale auth key is valid and not expired
- Verify the configuration files have proper permissions - Verify the configuration files have proper permissions
- Make sure required directories exist before starting - Make sure required directories exist before starting
## Notes ## Notes
- The {{Service}} service uses the Tailscale service's network stack via `network_mode: service:{{service}}-ts` - The Adguard service uses the Tailscale service's network stack via `network_mode: service:adguard-ts`
- Direct port mapping is disabled by default as Tailscale handles the networking - Direct port mapping is disabled by default as Tailscale handles the networking
- Services restart automatically unless explicitly stopped - Services restart automatically unless explicitly stopped
- For more information: - For more information:
- Tailscale documentation: https://tailscale.com/kb/ - Tailscale documentation: https://tailscale.com/kb/
- {{Service}} documentation: {{service_docs}} - Adguard documentation: https://adguard-dns.io/kb/adguard-home/getting-started/
- {{Service}} repository: {{service_repo}} - Adguard repository: https://github.com/AdguardTeam/AdGuardHome
- {{Service}} linuxserve.io: {{service_lcsr}}