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

manual init

Browse Source
This commit is contained in:
peskyadmin 2025-04-15 21:05:10 -05:00
parent bd5fe272b7
commit 7e2405cdc9
1 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -1,8 +1,8 @@
# {{Service}} with Tailscale Integration # Immich with Tailscale Integration
![{{Service}} with Tailscale](https://damconsulting.llc/images/logo_yellow.svg "{{Service}}") ![Immich with Tailscale](https://immich.app/img/immich-logo-inline-light.png "Immich")
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 Immich instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Immich instance using Tailscale.
## Prerequisites ## Prerequisites
@ -12,21 +12,21 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using
## Project Structure ## Project Structure
``` ```
ts-{{service}}/ ts-immich/
├── 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}}/ └── immich/
└── config/ # {{service}} configuration files └── config/ # immich configuration 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-immich
cd ts-{{service}} cd ts-immich
``` ```
2. Create Required Directories 2. Create Required Directories
```bash ```bash
@ -37,8 +37,9 @@ ts-{{service}}/
- 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 Immich
- See the [documentation]({{service_docs}}) for configuration options - A default configuration is provided in the `.env` file.
- See the [documentation](https://immich.app/docs/install/environment-variables) for additional configuration options
5. Start the Services 5. Start the Services
```bash ```bash
@ -48,30 +49,30 @@ ts-{{service}}/
6. Wait for Certificate to propagate [~2m] 6. Wait for Certificate to propagate [~2m]
7. Login 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://immich.{{YOUR_TAILNET_DOMAIN}}.ts.net ie https://immich.tail12345.ts.net/
## Services ## Services
### {{service}}-ts (Tailscale) ### immich-ts (Tailscale)
- Runs Tailscale VPN client - Runs Tailscale VPN client
- Image: tailscale/tailscale:latest - Image: tailscale/tailscale:latest
- Container name: {{service}}-ts - Container name: immich-ts
- Hostname: {{service}} - Hostname: immich
- 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}} ### immich
- Depends on {{service}}-ts service - Depends on immich-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://immich.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://immich.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 immich-ts
``` ```
Look for the Tailscale IP address in the logs. Look for the Tailscale IP address in the logs.
@ -80,7 +81,7 @@ ts-{{service}}/
- Uncomment and adjust the ports mapping if you need direct access (without Tailscale): - Uncomment and adjust the ports mapping if you need direct access (without Tailscale):
```yaml ```yaml
ports: ports:
- 3000:3000 - 2283:2283
``` ```
- Stopping the Services - Stopping the Services
```bash ```bash
@ -90,19 +91,19 @@ ts-{{service}}/
## Troubleshooting ## Troubleshooting
- Check container logs: - Check container logs:
```bash ```bash
docker logs {{service}}-ts docker logs immich-ts
docker logs {{service}} docker logs immich
``` ```
- 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 Immich service uses the Tailscale service's network stack via `network_mode: service:immich-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}}) - Immich [documentation]({{service_docs}})
- {{Service}} [repository]({{service_repo}}) - Immich [repository]({{service_repo}})
- {{Service}} [linuxserve.io]({{service_lcsr}}) - Immich [linuxserve.io]({{service_lcsr}})