Skip to content

Create .env.example to help with copy pasta deployments #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Create .env.example to help with copy pasta deployments #12

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4352489
Create .env.example to help with copy pasta deployments
gustavorps Sep 6, 2025
c58570b
Update .env.example with ALLOWED_IPS format
gustavorps Sep 6, 2025
5effdaf
Update ALLOWED_IPS in .env.example with default value
gustavorps Sep 6, 2025
db2377c
Revise .env.example for clarity and defaults
gustavorps Sep 6, 2025
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
22 changes: 22 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Content of allowed IP addresses
# To specific ips use something like bellow
# eg. ALLOWED_IPS="AllowUsers *@192.168.1.0/24 *@172.16.0.1 *@10.0.*.1"
# The default (bellow) allow the tunnel user from any IP
ALLOWED_IPS="AllowUsers tunnel"
# 🚨 Required to be set by you. Content of your authorized keys file
# eg. AUTHORIZED_KEYS="$(cat .ssh/my_many_ssh_public_keys_in_one_file.txt)"
AUTHORIZED_KEYS="REQUIRED_TO_BE_SET_BY_YOU"
# Display a bunch of helpful content for debugging.
DEBUG="true"
# Group ID the SSH user should run as.
PGID="9999"
# User ID the SSH user should run as.
PUID="9999"
# Group name used for our SSH user.
SSH_GROUP="tunnelgroup"
# Location of where the SSH host keys should be stored.
SSH_HOST_KEY_DIR="/etc/ssh/ssh_host_keys/"
# Listening port for SSH server (on container only. You'll still need to publish this port).
SSH_PORT="2222"
# Username for the SSH user that other users will connect into as.
SSH_USER="tunnel"