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

feat: bring ts-bookstack up to current template spec

Browse Source 
- Add SECURITY.md (matches template)
- Add tailscale/config/serve.headscale.json (HTTP-only variant)
- Default serve.json to Tailscale generic with ${TS_CERT_DOMAIN}
- Use linuxserver env var names (DB_USERNAME not DB_USER)
- Use named Docker volumes for cross-platform portability
- Both db and app use network_mode: service:bookstack-ts
- Rewrite README with Tailscale vs Headscale structure
- Rename db service to bookstack-db to avoid collisions with other ts-* repos
This commit is contained in:
peskyadmin
2026-08-02 21:46:17 -04:00
parent 4ecfa4c891
commit f652eea021
5 changed files with 167 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
README.md
View File

@@ -1,108 +1,66 @@
# {{Service}} with Tailscale Integration
# BookStack with Tailscale Integration
![{{Service}} with Tailscale](https://damconsulting.llc/images/logo_yellow.svg "{{Service}}")
![BookStack with Tailscale](https://raw.githubusercontent.com/BookStackApp/BookStack/master/logo.svg "BookStack")
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 BookStack instance with Tailscale VPN integration using Docker Compose.
## Prerequisites
## Quick Start (Tailscale)
- Docker and Docker Compose installed on your system
- A Tailscale account and auth key (get one from https://login.tailscale.com/admin/authkeys)
- Basic understanding of Docker and networking concepts
## Project Structure
```
ts-{{service}}/
├── docker-compose.yml
├── tailscale/
│ ├── tailscale-data/ # Persistent Tailscale state
│ └── config/ # Tailscale configuration files
└── {{service}}/
└── config/ # {{Service}} configuration files
```
## Setup Instructions
1. **Clone the Repository**
1. Copy the example environment file and fill in your values:
```bash
git clone https://gitea.damconsulting.llc/DAM/ts-{{service}}
cd ts-{{service}}
cp .env.example .env
```
2. Create Required Directories
```bash
mkdir -p tailscale/tailscale-data
```
3. Configure Tailscale
- Make sure `TS_AUTHKEY` and `TS_LOGIN_SERVER` are set in your environment (or a local .env file) before running docker compose.
- 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
2. Edit `.env` and set:
- `TS_AUTHKEY` — your Tailscale auth key
3. Generate a BookStack `APP_KEY` (32-char base64) — see https://bookstack.com/installation/generate-appkey
4. Start the stack:
```bash
docker compose up -d
```
5. Access BookStack at `http://bookstack.<your-tailnet>.ts.net`
4. Configure {{Service}}
- See the [documentation]({{service_docs}}) for configuration options
## Headscale
5. Start the Services
```bash
docker compose up -d
```
If you're using Headscale instead of Tailscale:
6. Wait for Certificate to propagate [~2m]
1. Copy the example environment file:
```bash
cp .env.example .env
```
2. Edit `.env` and set:
- `TS_AUTHKEY` — your Headscale auth key
- `TS_LOGIN_SERVER` — your Headscale server URL
3. Switch to the Headscale serve config:
```bash
cp tailscale/config/serve.headscale.json tailscale/config/serve.json
```
4. Edit `serve.json` and replace `bookstack.example.com` with your actual domain
5. Start the stack:
```bash
docker compose up -d
```
6. Access BookStack at `http://bookstack.yourdomain.com`
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/
## Configuration
## Services
See `.env.example` for all available options.
### {{service}}-ts (Tailscale)
### Switching Serve Configs
- Runs Tailscale VPN client
- Image: tailscale/tailscale:latest
- Container name: {{service}}-ts
- Hostname: {{service}}
- Requires NET_ADMIN and SYS_MODULE capabilities
- Persists state in ./tailscale/tailscale-data
- Uses configuration from ./tailscale/config
| Environment | File to use | Notes |
|-------------------|--------------------------------------|-------|
| Tailscale (default) | `tailscale/config/serve.json` | Supports HTTP + HTTPS with certs |
| Headscale | `tailscale/config/serve.headscale.json` | HTTP only |
### {{service}}
After changing the serve config, restart the sidecar:
```bash
docker compose restart bookstack-ts
```
- Depends on {{service}}-ts service
## Optional: Direct Host Access
## 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/`
- To manually get the Tailscale IP/hostname of your container:
```bash
docker logs {{service}}-ts
```
Look for the Tailscale IP address in the logs.
## Optional Features
- Uncomment and adjust the ports mapping if you need direct access (without Tailscale):
```yaml
ports:
- 3000:3000
```
- Stopping the Services
```bash
docker compose down
```
## Troubleshooting
- Check container logs:
```bash
docker logs {{service}}-ts
docker logs {{service}}
```
- 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`
- 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}})
Uncomment the ports section in `docker-compose.yml` if you need direct access without Tailscale:
```yaml
ports:
- 80:80
```