leviathonbeast/ionscale
1
0
Fork 0
mirror of https://github.com/jsiebens/ionscale.git synced 2026-03-31 15:07:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): update docs

Browse Source
This commit is contained in:
Johan Siebens
2024-04-26 11:22:06 +02:00
parent 128a184a59
commit 0b5f54c7d3
2 changed files with 14 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mkdocs/docs/getting-started/docker.md
+8 -8
View File
@@ -4,7 +4,7 @@ You can install and run __ionscale__ using the Docker images published on [GitHu
## Requirements
- A Linux machine with port 80 and 443 open to ingress traffic.
- A Linux machine with port 443 and 3478 open to ingress traffic.
- Docker installed. See the [official installation documentation](https://docs.docker.com/install/)
- A registered domain name.
@@ -33,15 +33,15 @@ Generate a configuration file for __ionscale__ with the following commands:
``` bash
export IONSCALE_ACME_EMAIL=<your email>
export IONSCALE_ADDR=https://ionscale.example.com
export IONSCALE_SYSTEM_ADMIN_KEY=$(docker run ghcr.io/jsiebens/ionscale:0.13.0 genkey -n)
export IONSCALE_DOMAIN=ionscale.example.com
export IONSCALE_SYSTEM_ADMIN_KEY=$(docker run ghcr.io/jsiebens/ionscale:0.15.0 genkey -n)
```
``` bash
tee ./config.yaml >/dev/null <<EOF
http_listen_addr: ":80"
https_listen_addr: ":443"
server_url: "${IONSCALE_ADDR}"
listen_addr: ":443"
public_addr: "${IONSCALE_DOMAIN}:443"
stun_public_addr: "${IONSCALE_DOMAIN}:3478"
tls:
acme: true
@@ -66,7 +66,7 @@ Run an __ionscale__ instance with the following command:
docker run \
-v $(pwd)/config.yaml:/etc/ionscale/config.yaml \
-v $(pwd)/data:/data \
-p 80:80 \
-p 443:443 \
ghcr.io/jsiebens/ionscale:0.13.0 server --config /etc/ionscale/config.yaml
-p 3478:3478/udp \
ghcr.io/jsiebens/ionscale:0.15.0 server --config /etc/ionscale/config.yaml
```
mkdocs/docs/getting-started/manual.md
+6 -7
View File
@@ -4,7 +4,7 @@ This tutorial will guide you through the steps needed to install and run __ionsc
## Prerequisites
- A Linux machine with port 80 and 443 open to ingress traffic.
- A Linux machine with port 443 and 3478 open to ingress traffic.
- A registered domain name.
## Step 1. Configure DNS
@@ -41,7 +41,7 @@ Run the following commands to install the __ionscale__ binary on your Linux host
``` bash
sudo curl \
-o "/usr/local/bin/ionscale" \
-sfL "https://github.com/jsiebens/ionscale/releases/download/v0.13.0/ionscale_linux_amd64"
-sfL "https://github.com/jsiebens/ionscale/releases/download/v0.15.0/ionscale_linux_amd64"
sudo chmod +x "/usr/local/bin/ionscale"
```
@@ -60,19 +60,18 @@ Generate a configuration file for __ionscale__ with the following commands:
``` bash
export IONSCALE_ACME_EMAIL=<your email>
export IONSCALE_ADDR=https://ionscale.example.com
export IONSCALE_DOMAIN=ionscale.example.com
```
``` bash
sudo tee /etc/ionscale/config.yaml >/dev/null <<EOF
http_listen_addr: ":80"
https_listen_addr: ":443"
server_url: "https://${IONSCALE_DOMAIN}"
listen_addr: ":443"
public_addr: "${IONSCALE_DOMAIN}:443"
stun_public_addr: "${IONSCALE_DOMAIN}:3478"
tls:
acme: true
acme_email: "${IONSCALE_ACME_EMAIL}"
acme_path: "/var/lib/ionscale/acme"
database:
url: "/var/lib/ionscale/ionscale.db?_pragma=busy_timeout(5000)&_pragma=journal_mode(WAL)"