Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

## Related Issues
<!-- Link any related issues (e.g. Fixes #123). Use "None" if not applicable. -->

- None.

## Verification
Expand All @@ -20,4 +21,5 @@

## Additional Context
<!-- Any extra info for reviewers, such as gotchas, special requirements, devices, or dependencies. Use "None" if not applicable. -->

- None.
12 changes: 6 additions & 6 deletions .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ jobs:
steps:
- name: Clone this repo
uses: actions/checkout@v6

- name: Markdown Linting Action
id: lint
uses: avto-dev/markdown-lint@v1.5.0

- name: Lint services
uses: rvben/rumdl@v0.1.80
with:
config: "./.markdownlint.yml"
args: "./services/**/*.md"
path: "services/"
config: ".markdownlint.yml"
report-type: annotations
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,20 @@ ScaleTail provides ready-to-run [Docker Compose](https://docs.docker.com/compose
Go to the [Tailscale Admin Console → Keys](https://login.tailscale.com/admin/settings/keys) and generate a new auth key.

2. **Clone and Choose a Service**

Clone the repository and change directory to your desired service with the following command:

``` bash
git clone https://github.com/tailscale-dev/ScaleTail.git
cd ScaleTail/services/YourDesiredService
```

3. **Configure and Launch**

- Open the `.env` file in your chosen service directory.
- Add your auth key after the line `TS_AUTHKEY=`.
- Start the Docker compose stack:

``` bash
docker compose up -d
```
Expand Down
4 changes: 2 additions & 2 deletions documentation/tailscale-on-arm.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ First, attempt to install Tailscale using the official script:
curl -fsSL https://tailscale.com/install.sh | sh
```

- If this works, skip ahead to [Step 4](#4-run-tailscale).
- If this works, skip ahead to [Step 4](#4-create-an-initd-service-for-tailscale).
- If it fails (common on OpenPLi), continue with the manual installation below.

---
Expand Down Expand Up @@ -135,7 +135,7 @@ tailscale up

You will receive an authentication URL, for example:

```
```text
To authenticate, visit:

https://login.tailscale.com/c/129a3b4e01e114a
Expand Down
2 changes: 1 addition & 1 deletion services/adguardhome/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ In Debian (e.g. Ubuntu Server 22.04.x / 24.04.x) systems, particularly when usin
`DNSStubListener` is a configuration option in the `/etc/systemd/resolved.conf` file that controls whether the `systemd-resolved` service will listen for DNS queries on the loopback address (127.0.0.53) over port 53.

- **DNSStubListener=yes**: When this option is enabled, `systemd-resolved` binds to `127.0.0.53:53`. This allows the system to use `systemd-resolved` as a local DNS resolver for local DNS queries.

- **DNSStubListener=no**: Disabling the stub listener prevents `systemd-resolved` from binding to port 53 on the local interface, freeing up this port for other DNS services or applications that require direct control over port 53.

### Why Change `DNSStubListener` to `no`?
Expand Down
2 changes: 1 addition & 1 deletion services/glance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This Docker Compose configuration sets up [Glance](https://github.com/glanceapp/

[Glance](https://github.com/glanceapp/glance) is a sleek, real-time dashboard for monitoring your system metrics, Docker containers, and other self-hosted services. It offers a clean and responsive interface that consolidates key system stats and service statuses in one place. This configuration uses Tailscale to securely expose your Glance instance, keeping it protected from the public internet and accessible only within your private Tailscale network.

To install Glance properly, make sure to add the files glance.yml and home.yml to the config folder. The contents of these files can be found [here](https://github.com/glanceapp/docker-compose-template/tree/main/root/config). Also add the file user.css to the assets folder which can be found [here](https://github.com/glanceapp/docker-compose-template/tree/main/root/assets).
To install Glance properly, make sure to add the files glance.yml and home.yml to the config folder. The contents of these files can be found [at their Github repo](https://github.com/glanceapp/docker-compose-template/tree/main/root/config). Also add the file user.css to the assets folder which can be found [at their Github repo](https://github.com/glanceapp/docker-compose-template/tree/main/root/assets).

## Configuration Overview

Expand Down
2 changes: 1 addition & 1 deletion services/paperless/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Paperless-ngx with Tailscale Sidecar Configuration
# Paperless-ngx with Tailscale Sidecar Configuration

This Docker Compose configuration sets up [Paperless-ngx](https://docs.paperless-ngx.com/) with Tailscale as a sidecar container to securely deliver push notifications over a private Tailscale network. By integrating Tailscale in a sidecar configuration, you enhance the privacy and security of your ntfy instance, ensuring it is only accessible within your Tailscale network.

Expand Down
2 changes: 1 addition & 1 deletion services/rustdesk-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In this setup, the `tailscale-rustdesk-server` service runs Tailscale, which man

## Client setup

- Service Configuration: The Rustdesk client public Key credentials are generated at first run and stored in the **id_ed25519.pub** file. This is found in the compose directory **./rustdesk-server-data/hbbs/** Clients can be setup using the --config switch. e.g. **rustdesk.exe --config "host=rustdesk.your-tailnet.ts,key=thetextfromkey"** or in the client Setting -> Network -> ID/Relay Server. There is no need to configure the relay or API server.
- Service Configuration: The Rustdesk client public Key credentials are generated at first run and stored in the **id_ed25519.pub** file. This is found in the compose directory **./rustdesk-server-data/hbbs/** Clients can be setup using the --config switch. e.g. **rustdesk.exe --config "host=rustdesk.your-tailnet.ts,key=thetextfromkey"** or in the client Setting -> Network -> ID/Relay Server. There is no need to configure the relay or API server.

Links:

Expand Down