A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.
docs(operator): explain installs without a public IP address (#3759)
Hampus893f3e13a294
diff --git a/fluxer_docs/src/content/docs/operator/environment.mdx b/fluxer_docs/src/content/docs/operator/environment.mdxindex 53d839b7c..5e5e79e88 100644--- a/fluxer_docs/src/content/docs/operator/environment.mdx+++ b/fluxer_docs/src/content/docs/operator/environment.mdx@@ -346,7 +346,7 @@ The public addresses LiveKit gives to clients. Give an IPv4 address, an IPv6 add### `FLUXER_VOICE_ICE_IPS`-The address ranges LiveKit may offer to clients, as a JSON array of ranges such as `["::/0"]`. rexctl sets it to the families in `FLUXER_VOICE_NODE_IP`, so a server with only IPv6 offers no private IPv4 address of its container. Use `[]` to offer every address.+The address ranges LiveKit may offer to clients, as a JSON array of ranges such as `["::/0"]`. rexctl sets it to the families in `FLUXER_VOICE_NODE_IP`, and a server with only IPv6 then offers no private IPv4 address of its container. Use `[]` to offer every address.### `FLUXER_VOICE_USE_EXTERNAL_IP`@@ -462,7 +462,7 @@ Whether data export and admin download links are presigned URLs to the object st### `FLUXER_API_STORAGE_CHANGE_FEED_ENABLED`-Whether the api and worker services publish a record of each object store write and delete they make to a NATS JetStream stream. Uploads written by the media proxy relay or sent straight to the store by clients are not in it. Use `true` or `false`. When it's empty, the feed is off. With rexctl, use `rexctl config set FLUXER_API_STORAGE_CHANGE_FEED_ENABLED`.+Whether the api and worker services publish a record of each object store write and delete they make to a NATS JetStream stream. Uploads written by the media proxy relay or sent directly to the store by clients are not in it. Use `true` or `false`. When it's empty, the feed is off. With rexctl, use `rexctl config set FLUXER_API_STORAGE_CHANGE_FEED_ENABLED`.### `FLUXER_API_STORAGE_CHANGE_FEED_STREAM`@@ -642,7 +642,7 @@ Hosts the Rust services other than the app-proxy connect to without the proxy, s### `FLUXER_NODE_EXTRA_CA_CERTS`-The path of a PEM file of CA certificates that the api and worker trust for outgoing TLS on top of Node's built-in ones. Use it when your email server has a certificate from your own CA. The path is inside their containers. With Docker Compose they see the ca folder of your instance at `/etc/fluxer/ca`, and nothing else from the instance folder. A file you set replaces the system bundle. Node's built-in CAs still apply, and the file can hold only your own CA. The Rust services don't use it and take their CA certificates from `SSL_CERT_FILE`. The default is `/etc/ssl/certs/ca-certificates.crt`. With rexctl, use `rexctl config set FLUXER_NODE_EXTRA_CA_CERTS`.+The path of a PEM file of CA certificates that the api and worker trust for outgoing TLS on top of Node's built-in ones. Use it when your email server has a certificate from your own CA. The path is inside their containers. With Docker Compose they see the ca folder of your instance at `/etc/fluxer/ca`, and nothing else from the instance folder. A file you set replaces the system bundle. Node's built-in CAs still apply, and the file can have only your own CA. The Rust services don't use it and take their CA certificates from `SSL_CERT_FILE`. The default is `/etc/ssl/certs/ca-certificates.crt`. With rexctl, use `rexctl config set FLUXER_NODE_EXTRA_CA_CERTS`.## Sign-in@@ -838,7 +838,7 @@ Hostnames, separated by commas, of the push relay that Fluxer runs. When it's em### `FLUXER_PUSH_SERVICE_OWN_RELAY_HOSTS`-Hostnames, separated by commas, of a push relay your instance runs itself. The push service sends mobile app notifications addressed to these hosts straight to APNs or FCM with its own credentials. With rexctl, use `rexctl config set FLUXER_PUSH_SERVICE_OWN_RELAY_HOSTS`.+Hostnames, separated by commas, of a push relay your instance runs itself. The push service sends mobile app notifications addressed to these hosts directly to APNs or FCM with its own credentials. With rexctl, use `rexctl config set FLUXER_PUSH_SERVICE_OWN_RELAY_HOSTS`.### `FLUXER_PUSH_SERVICE_PRIVATE_HOSTS`@@ -1538,7 +1538,7 @@ The share of deleted space in a volume that makes SeaweedFS compact it, as a fra### `FLUXER_SEAWEEDFS_S3_CONCURRENT_UPLOADS`-How many uploads the bundled object store writes at once, set as its `-s3.concurrentFileUploadLimit`. More uploads wait for a free slot. Each upload in progress holds up to 32 MB of memory in SeaweedFS. Raise `FLUXER_SEAWEEDFS_MEMORY_LIMIT` before you raise this. The default is `5`. rexctl sizes this. With rexctl, use `rexctl config set FLUXER_SEAWEEDFS_S3_CONCURRENT_UPLOADS`.+How many uploads the bundled object store writes at once, set as its `-s3.concurrentFileUploadLimit`. More uploads wait for a free slot. Each upload in progress uses up to 32 MB of memory in SeaweedFS. Raise `FLUXER_SEAWEEDFS_MEMORY_LIMIT` before you raise this. The default is `5`. rexctl sizes this. With rexctl, use `rexctl config set FLUXER_SEAWEEDFS_S3_CONCURRENT_UPLOADS`.### `FLUXER_SEAWEEDFS_VOLUME_MAX`diff --git a/fluxer_docs/src/content/docs/operator/index.mdx b/fluxer_docs/src/content/docs/operator/index.mdxindex bd57a8aed..4919fb64a 100644--- a/fluxer_docs/src/content/docs/operator/index.mdx+++ b/fluxer_docs/src/content/docs/operator/index.mdx@@ -10,7 +10,7 @@ rexctl installs Fluxer on one machine and keeps it running. To run Fluxer on a K## What you need-- A 64-bit Linux, macOS or Windows machine with at least 2 CPU cores, 4 GB of memory and 20 GB of free disk space. That's enough for about 1,000 people online at the same time. rexctl sizes Fluxer to the machine's memory and CPUs every time it starts, so a bigger machine needs no extra settings.+- A 64-bit Linux, macOS or Windows machine with at least 2 CPU cores, 4 GB of memory and 20 GB of free disk space. That's enough for about 1,000 people online at the same time. rexctl sizes Fluxer to the machine's memory and CPUs every time it starts, and a bigger machine needs no extra settings.- On macOS and Windows, [Docker Desktop](https://docs.docker.com/desktop/). On Linux, rexctl installs Docker for you if it's missing.- A domain or subdomain for your instance, such as `chat.example.com`.- An `A` record for that domain pointing to the machine's public IP address. rexctl checks it before it asks for a certificate.@@ -45,17 +45,37 @@ rexctl asks where you want to create your admin account. "Here in the terminal"Once you've created the admin account, people can open your instance's address in a browser or enter it in the desktop and mobile apps.+## Without a public IP address++Behind CGNAT, or anywhere you can't forward ports, serve Fluxer through a tunnel such as Cloudflare Tunnel. Install with `--behind-proxy` and point the tunnel at `http://127.0.0.1:8080`. In this mode rexctl only checks that your domain resolves to some address.++```sh+curl -fsSL https://fluxer.dev/install.sh | sh -s -- install --behind-proxy --bind 127.0.0.1:8080+```++Calls don't go through a tunnel, and they need a TURN server on a machine with a public address, as [Voice behind a tunnel](/operator/reverse-proxy/#voice-behind-a-tunnel) explains.++To run Fluxer only on your own network, use a name that isn't on the public internet, such as `chat.home.arpa` or `fluxer.internal`. rexctl skips the DNS check for names like these and for IP addresses. Make the name resolve to the machine on every device, through your router's DNS or each device's hosts file. Only devices on your network can open the instance.++Fluxer gets certificates for names ending in `.home.arpa`, `.internal`, `.local` or `.localhost` from its own local certificate authority. Browsers and apps don't trust it until you install its root certificate on each device. This command copies the root certificate out of the instance.++```sh+docker cp "$(docker ps --format '{{.Names}}' | grep -m1 edge)":/data/caddy/pki/authorities/local/root.crt fluxer-root.crt+```++For any other private name, run `rexctl config set FLUXER_EDGE_TLS internal` to use the same local certificate authority.+## Where Fluxer keeps its filesFluxer uses three places on the machine:-- The instance folder holds your settings, the files rexctl makes for Docker, and backups. It's `/opt/fluxer` when you install as root and `~/fluxer` otherwise.-- Docker's data root holds the images and all of Fluxer's data, such as the database, uploads and search index. It's `/var/lib/docker` on most Linux machines.+- The instance folder has your settings, the files rexctl makes for Docker and your backups. It's `/opt/fluxer` when you install as root and `~/fluxer` otherwise.+- Docker's data root has the images and all of Fluxer's data, such as the database, uploads and search index. It's `/var/lib/docker` on most Linux machines.- The backup folder is `backups` in the instance folder unless you choose another one with `rexctl backup location <folder>`.-The install needs 20 GB free on the disk with the instance folder and on the disk with Docker's data root. If either one is short, rexctl names the path.+The install needs 20 GB free on the disk with the instance folder and on the disk with Docker's data root. If either one is short, rexctl says which path it is.-To put Fluxer on a second drive, set `data-root` in `/etc/docker/daemon.json` to a folder on that drive and restart Docker before you install, so Docker keeps the images and data there. Then start the install with `--dir` and a folder on the same drive:+To put Fluxer on a second drive, set `data-root` in `/etc/docker/daemon.json` to a folder on that drive and restart Docker before you install. Docker then keeps the images and data on that drive. Start the install with `--dir` and a folder on the same drive.```shcurl -fsSL https://fluxer.dev/install.sh | sh -s -- install --dir /mnt/data/fluxerdiff --git a/fluxer_docs/src/content/docs/operator/reverse-proxy.mdx b/fluxer_docs/src/content/docs/operator/reverse-proxy.mdxindex da7d302a6..440dd676c 100644--- a/fluxer_docs/src/content/docs/operator/reverse-proxy.mdx+++ b/fluxer_docs/src/content/docs/operator/reverse-proxy.mdx@@ -121,7 +121,7 @@ If Cloudflare proxies your domain, change these settings in the Cloudflare dashb### Purging deleted media-Cloudflare keeps serving cached copies of media after someone deletes it, until the cached copy expires. Fluxer can ask Cloudflare to purge those copies straight away. Create an API token with the Zone Cache Purge permission for your zone, find the zone ID on the zone's overview page, and set these variables.+Cloudflare keeps serving cached copies of media after someone deletes it, until the cached copy expires. Fluxer can ask Cloudflare to purge those copies right away. Create an API token with the Zone Cache Purge permission for your zone, find the zone ID on the zone's overview page, and set these variables.```bashrexctl config set FLUXER_CACHE_PURGE_ADAPTER httpdiff --git a/fluxer_docs/src/content/docs/operator/rexctl.mdx b/fluxer_docs/src/content/docs/operator/rexctl.mdxindex da4474a1b..c87426f69 100644--- a/fluxer_docs/src/content/docs/operator/rexctl.mdx+++ b/fluxer_docs/src/content/docs/operator/rexctl.mdx@@ -104,7 +104,7 @@ rexctl auto-upgrade on [flags]## rexctl backup-Back up your instance in one file that restores on this machine or a new one. It holds the database, search data and uploads that Fluxer stores itself. Fluxer pauses while uploads are copied.+Back up your instance in one file that restores on this machine or a new one. It has the database, search data and uploads that Fluxer stores itself. Fluxer pauses while uploads are copied.```shrexctl backup@@ -843,7 +843,7 @@ rexctl upgrade [flags]## rexctl use-Show which instance rexctl uses when you don't pass --dir and aren't in an instance folder, or pass a folder to use that instance from now on. rexctl remembers each instance it installs, so you only need this with more than one instance or one installed by an older rexctl. Each account has its own choice. Root's choice also applies to accounts that have no instance of their own. The services rexctl sets up for starting and upgrading Fluxer always name their folder, so this doesn't change them.+Show which instance rexctl uses when you don't pass --dir and aren't in an instance folder, or pass a folder to use that instance from now on. rexctl remembers each instance it installs. You only need this with more than one instance or one installed by an older rexctl. Each account has its own choice. Root's choice also applies to accounts that have no instance of their own. The services rexctl sets up for starting and upgrading Fluxer always pass their own folder, and this choice doesn't change them.```shrexctl use [folder]diff --git a/fluxer_docs/src/content/docs/operator/running.mdx b/fluxer_docs/src/content/docs/operator/running.mdxindex e4d6e3085..0402df7e1 100644--- a/fluxer_docs/src/content/docs/operator/running.mdx+++ b/fluxer_docs/src/content/docs/operator/running.mdx@@ -59,7 +59,7 @@ rexctl rollbackThis goes back to the version you had before your last upgrade and keeps your database as it is. To also restore the backup rexctl made before the upgrade, add `--restore-database`.-If that backup leaves out uploads, the uploads stay as they are. Files uploaded since the upgrade stay on disk, and attachments deleted since the upgrade don't come back. For backups before upgrades that also hold uploads, run `rexctl auto-upgrade on` again with your other flags and `--backup full`, or pass `--backup full` to `rexctl upgrade`. This applies from the next upgrade.+If that backup leaves out uploads, the uploads stay as they are. Files uploaded since the upgrade stay on disk, and attachments deleted since the upgrade don't come back. For backups before upgrades that also include uploads, run `rexctl auto-upgrade on` again with your other flags and `--backup full`, or pass `--backup full` to `rexctl upgrade`. This applies from the next upgrade.### Custom badges and rollbacks@@ -173,11 +173,11 @@ This lists every setting with its value and a line of help, and says which settirexctl config set <key> <value>```-The list includes the `FLUXER_*` environment variables Fluxer reads, and you set them the same way. If a variable has a shorter name, such as `sso.allow_private_addresses` for `FLUXER_SSO_ALLOW_PRIVATE_ADDRESSES`, rexctl tells you to use that one. rexctl writes the change and restarts whatever needs it, so you never edit `.env` yourself.+The list includes the `FLUXER_*` environment variables Fluxer reads, and you set them the same way. If a variable has a shorter name, such as `sso.allow_private_addresses` for `FLUXER_SSO_ALLOW_PRIVATE_ADDRESSES`, rexctl tells you to use that one. rexctl writes the change and restarts whatever needs it, and you never edit `.env` yourself.-Each time rexctl starts Fluxer, it sizes memory limits, database connections and thread counts to the machine's memory and CPUs, so a resized machine needs no changes. The `memory.profile` setting pins a fixed size instead.+Each time rexctl starts Fluxer, it sizes memory limits, database connections and thread counts to the machine's memory and CPUs, and a resized machine needs no changes. The `memory.profile` setting pins a fixed size instead.-On a machine with little memory, `rexctl config set FLUXER_API_EMBEDDED_WORKER true` runs background jobs inside the api service instead of a separate worker service. rexctl then removes the worker and adds half of its memory limit to the api.+On a machine with little memory, `rexctl config set FLUXER_API_EMBEDDED_WORKER true` runs background jobs inside the api service. rexctl then removes the separate worker service and adds half of its memory limit to the api.## Change how Fluxer runsdiff --git a/fluxer_docs/src/content/docs/operator/sign-in.mdx b/fluxer_docs/src/content/docs/operator/sign-in.mdxindex d69fffac7..5235dd469 100644--- a/fluxer_docs/src/content/docs/operator/sign-in.mdx+++ b/fluxer_docs/src/content/docs/operator/sign-in.mdx@@ -20,7 +20,7 @@ People create an account with an email address, a username and a password. The iPeople can sign in through your own identity provider, such as Authentik or Keycloak, over OpenID Connect. Set it up in the admin panel on the "Instance Config" page, in the "Single Sign-On (SSO)" card. Fill in the details from your provider, turn on "Enable SSO" and register the "Redirect URI" that the card shows with your provider.-The issuer URL is required, and Fluxer only accepts sign-ins that your provider issued under it. It accepts the issuer with or without a trailing `/`. For Microsoft Entra ID, use your tenant's issuer, `https://login.microsoftonline.com/<tenant>/v2.0`, not `/common`. SSO that was set up without an issuer stays off until you add one. Upgrade first, then run `rexctl config set sso.issuer <issuer URL>` straight away. Fluxer moves the existing links to the issuer when it finds the same provider there. Don't add the issuer before you upgrade, because older versions leave the links behind. People who are already signed in stay signed in, and if Require SSO is on, `rexctl admins sign-in-link <admin>` gets you in.+The issuer URL is required, and Fluxer only accepts sign-ins that your provider issued under it. It accepts the issuer with or without a trailing `/`. For Microsoft Entra ID, use your tenant's issuer, `https://login.microsoftonline.com/<tenant>/v2.0`, not `/common`. SSO that was set up without an issuer stays off until you add one. Upgrade first, then run `rexctl config set sso.issuer <issuer URL>` right away. Fluxer moves the existing links to the issuer when it finds the same provider there. Don't add the issuer before you upgrade, because older versions leave the links behind. People who are already signed in stay signed in, and if Require SSO is on, `rexctl admins sign-in-link <admin>` gets you in.On an email instance, and whenever "Allowed Email Domains" is filled in, Fluxer only takes an email address that your provider marks as verified with the `email_verified` claim. Microsoft Entra ID doesn't send that claim. Add the optional `xms_edov` claim to the ID token in your Entra app registration, and Fluxer accepts it in its place. Register Fluxer as a single-tenant app. OneLogin also leaves `email_verified` out by default. Set your OneLogin app to send the `email_verified` claim, or every sign-in on an email instance is refused with `SSO_EMAIL_NOT_VERIFIED`.@@ -49,7 +49,7 @@ If someone has two-factor authentication or a passkey on their Fluxer account, FOn a username instance you can turn on "Usernames come from your sign-in provider" (`sso.username_from_provider` in rexctl). It's off by default and doesn't depend on Require SSO. While it's on, each SSO sign-in sets the person's username from the `preferred_username` claim, and people who sign in with SSO can't change it in Fluxer.-Usernames can only use letters, numbers and underscores, up to 32 characters. Fluxer keeps the part before any `@`, turns accented letters into plain ones, turns dots, dashes and spaces into underscores, drops other characters, removes the word `fluxer` and keeps the first 32 characters. For example, `[email protected]` becomes `john_doe`. This means different people can end up with the same username. `[email protected]` and `[email protected]` both become `alice`, and whoever signs in first keeps it. If your provider sends an email address or UPN as `preferred_username`, such as Entra ID with more than one domain, map that claim to a value that is unique across your tenant.+Usernames can only use letters, numbers and underscores, up to 32 characters. Fluxer keeps the part before any `@`, turns accented letters into plain ones, turns dots, dashes and spaces into underscores, drops other characters, removes the word `fluxer` and keeps the first 32 characters. For example, `[email protected]` becomes `john_doe`. Different people can end up with the same username. `[email protected]` and `[email protected]` both become `alice`, and whoever signs in first keeps it. If your provider sends an email address or UPN as `preferred_username`, such as Entra ID with more than one domain, map that claim to a value that is unique across your tenant.If the claim is missing, isn't usable or belongs to someone else, the person keeps their current username. A rename in the admin panel lasts until the person's next SSO sign-in. Turn off username editing at your provider, or anyone who can edit their own `preferred_username` can take any free name here.diff --git a/fluxer_docs/src/content/docs/operator/voice-compose.mdx b/fluxer_docs/src/content/docs/operator/voice-compose.mdxindex 567ced9c8..5917dd161 100644--- a/fluxer_docs/src/content/docs/operator/voice-compose.mdx+++ b/fluxer_docs/src/content/docs/operator/voice-compose.mdx@@ -120,7 +120,7 @@ curl https://voice-fra.chat.example.com/livekit-fra-server-1/### Behind your own proxy-When nginx or another proxy already holds ports 80 and 443 on the machine, skip the edge and let your proxy serve the server.+When nginx or another proxy already uses ports 80 and 443 on the machine, skip the edge and let your proxy serve the server.1. Create the network that the servers join. Do this once on the machine.diff --git a/fluxer_docs/src/content/docs/operator/voice-servers.mdx b/fluxer_docs/src/content/docs/operator/voice-servers.mdxindex cd89a8857..c5cc908c3 100644--- a/fluxer_docs/src/content/docs/operator/voice-servers.mdx+++ b/fluxer_docs/src/content/docs/operator/voice-servers.mdx@@ -33,7 +33,7 @@ rexctl picks every value and shows them in one summary before it changes anythin- **Endpoint.** A path on your domain, such as `wss://chat.example.com/livekit-default-server-2`. It needs no DNS record, no new certificate and no change to a proxy that forwards every path.- **Keys.** The key `fluxer-` followed by the ID, and a new random secret.- **Address, memory and image.** The same public address, LiveKit release and memory limit as the bundled server.-- **Soft limit.** 75 connections per CPU. Placement prefers another server once a server holds this many.+- **Soft limit.** 75 connections per CPU. Placement prefers another server once a server has this many.Add several at once with `--count`.@@ -130,7 +130,7 @@ Then pass it when you join.rexctl voice join chat.example.com fvj_... --hostname voice-fra.chat.example.com```-When `voice-` followed by the region and your domain already points at the machine, rexctl uses it without being asked. When the hostname doesn't point at the machine yet, rexctl prints the records and waits up to 10 minutes. After that it uses the IP address and prints the command to switch later. With `--yes`, or without a terminal, it uses the IP address straight away. A machine with only IPv6 has no IP address to fall back to. There rexctl waits up to 10 minutes for the `AAAA` record even with `--yes`, and stops when the record still doesn't point at the machine.+When `voice-` followed by the region and your domain already points at the machine, rexctl uses it without being asked. When the hostname doesn't point at the machine yet, rexctl prints the records and waits up to 10 minutes. After that it uses the IP address and prints the command to switch later. With `--yes`, or without a terminal, it uses the IP address right away. A machine with only IPv6 has no IP address to fall back to. There rexctl waits up to 10 minutes for the `AAAA` record even with `--yes`, and stops when the record still doesn't point at the machine.A token made with `--hostname` works only with that hostname. rexctl stops when you pass another one. It waits up to 10 minutes for the name to point at the machine, also with `--yes`, and stops before it starts anything when the name still doesn't. Add the record, then run the same command again.@@ -140,7 +140,7 @@ rexctl voice hostname fra-server-1 voice-fra.chat.example.comOn Cloudflare, set this record to **DNS only**. `rexctl voice join` checks that the name points at the machine before the edge asks Let's Encrypt for a certificate, and a proxied name points at Cloudflare. Remove any `AAAA` record that points somewhere else, because Let's Encrypt checks IPv6 first.-A server from `rexctl voice add` uses your instance's domain, which can stay proxied. Only signalling goes through Cloudflare. Audio and video go straight to the machine's IP address, which LiveKit gives to clients.+A server from `rexctl voice add` uses your instance's domain, which can stay proxied. Only signalling goes through Cloudflare. Audio and video go directly to the machine's IP address, which LiveKit gives to clients.## IPv6@@ -174,7 +174,7 @@ Without a TURN server, a caller with only IPv4 can't join a call on a server witWith `allocation-default-address-family="ipv6"`, the TURN server gives no useful relay for a voice server with only IPv4. Callers who need the TURN server can't connect to such a server with that setting. Your instance gives every voice server the same list of TURN servers. Use the setting only when every voice server of your instance has IPv6.-`rexctl voice test <id>` on a Fluxer machine with IPv4 tries **IPv4 through TURN** for a server with only IPv6, when your instance has TURN servers. It opens the WebSocket over IPv4, which goes to the machine the `A` record points at, and connects media only through the TURN servers the voice server gives clients over UDP and TCP, which it connects to over IPv4. Like a browser, it asks for no address family, so it passes only when the TURN server hands out IPv6 relay addresses. When the instance has no TURN servers, the test skips this.+`rexctl voice test <id>` on a Fluxer machine with IPv4 tries **IPv4 through TURN** for a server with only IPv6, when your instance has TURN servers. It opens the WebSocket over IPv4, which goes to the machine the `A` record points at, and connects media only through the TURN servers the voice server gives clients over UDP and TCP, which it connects to over IPv4. Like a browser, it asks for no address family, and it passes only when the TURN server hands out IPv6 relay addresses. When the instance has no TURN servers, the test skips this.### Machines that joined before@@ -225,11 +225,11 @@ Behind a router or another NAT, forward each port to the same port number on the## Machines with something else on ports 80 and 443-When another rexctl Fluxer instance holds ports 80 and 443 on the voice machine, the server uses that instance's domain and edge, such as `wss://other.example.com/livekit-fra-server-1`. You can't pass `--hostname` then.+When another rexctl Fluxer instance uses ports 80 and 443 on the voice machine, the server uses that instance's domain and edge, such as `wss://other.example.com/livekit-fra-server-1`. You can't pass `--hostname` then.The server's files go in the voice folder, and the Fluxer instance stays the default folder. `rexctl voice status`, `rexctl voice test` and `rexctl voice remove` find the server by its ID. The server uses that instance's domain, and `rexctl voice hostname` doesn't apply to it. `rexctl upgrade` on the Fluxer instance upgrades it too. Other commands for it need `--dir` with the voice folder.-When nginx or another program holds them, rexctl stops. Pass `--no-edge` and the public address of your own proxy.+When nginx or another program uses them, rexctl stops. Pass `--no-edge` and the public address of your own proxy.```shrexctl voice join chat.example.com fvj_... --no-edge --endpoint wss://voice.example.com/livekit-fra-server-1diff --git a/fluxer_rexctl/cmd/backup.go b/fluxer_rexctl/cmd/backup.goindex fb360d78e..fec12ebd1 100644--- a/fluxer_rexctl/cmd/backup.go+++ b/fluxer_rexctl/cmd/backup.go@@ -26,7 +26,7 @@ func newBackupCmd(app *App) *cobra.Command {c := &cobra.Command{Use: "backup",Short: "Back up your instance",- Long: "Back up your instance in one file that restores on this machine or a new one. It holds the database, search data and uploads that Fluxer stores itself. Fluxer pauses while uploads are copied.",+ Long: "Back up your instance in one file that restores on this machine or a new one. It has the database, search data and uploads that Fluxer stores itself. Fluxer pauses while uploads are copied.",Args: noArgs,RunE: func(c *cobra.Command, _ []string) error {return runBackup(c.Context(), app)diff --git a/fluxer_rexctl/cmd/use.go b/fluxer_rexctl/cmd/use.goindex ae962ff67..b1caa4105 100644--- a/fluxer_rexctl/cmd/use.go+++ b/fluxer_rexctl/cmd/use.go@@ -18,9 +18,9 @@ func newUseCmd(app *App) *cobra.Command {Use: "use [folder]",Short: "Show or change which instance rexctl uses",Long: "Show which instance rexctl uses when you don't pass --dir and aren't in an instance folder, or pass a folder to use that instance from now on. " +- "rexctl remembers each instance it installs, so you only need this with more than one instance or one installed by an older rexctl. " ++ "rexctl remembers each instance it installs. You only need this with more than one instance or one installed by an older rexctl. " +"Each account has its own choice. Root's choice also applies to accounts that have no instance of their own. " +- "The services rexctl sets up for starting and upgrading Fluxer always name their folder, so this doesn't change them.",+ "The services rexctl sets up for starting and upgrading Fluxer always pass their own folder, and this choice doesn't change them.",Args: maxArgs(1),RunE: func(c *cobra.Command, args []string) error {if len(args) == 0 {diff --git a/fluxer_rexctl/internal/instance/envvars.go b/fluxer_rexctl/internal/instance/envvars.goindex cdbedd651..9be01439b 100644--- a/fluxer_rexctl/internal/instance/envvars.go+++ b/fluxer_rexctl/internal/instance/envvars.go@@ -111,7 +111,7 @@ var envVars = []envVar{{"FLUXER_VOICE_TCP_PORT", "voice-server", "The TCP port for media on this host. LiveKit listens on the same port inside the container, and each server on a host needs its own."},{"FLUXER_VOICE_UDP_PORT", "voice-server", "The UDP port for media on this host. LiveKit listens on the same port inside the container, and each server on a host needs its own."},{"FLUXER_VOICE_NODE_IP", "voice-server", "The public addresses LiveKit gives to clients. Give an IPv4 address, an IPv6 address, or both with a comma between them, such as `203.0.113.7,2001:db8::7`. Set FLUXER_VOICE_USE_EXTERNAL_IP to `false` with it. LiveKit offers an IPv6 address only when the server's Docker network has IPv6."},- {"FLUXER_VOICE_ICE_IPS", "voice-server", "The address ranges LiveKit may offer to clients, as a JSON array of ranges such as `[\"::/0\"]`. rexctl sets it to the families in FLUXER_VOICE_NODE_IP, so a server with only IPv6 offers no private IPv4 address of its container. Use `[]` to offer every address."},+ {"FLUXER_VOICE_ICE_IPS", "voice-server", "The address ranges LiveKit may offer to clients, as a JSON array of ranges such as `[\"::/0\"]`. rexctl sets it to the families in FLUXER_VOICE_NODE_IP, and a server with only IPv6 then offers no private IPv4 address of its container. Use `[]` to offer every address."},{"FLUXER_VOICE_USE_EXTERNAL_IP", "voice-server", "Whether LiveKit finds its public IP address through STUN. Use `true` or `false`."},{"FLUXER_VOICE_BIND_IP", "voice-server", "The host address the media ports are published on, for a host with more than one public address. When it's empty, Docker publishes them on every address."},{"FLUXER_VOICE_HTTP_PORT", "voice-server", "The port that voice-http.compose.yml publishes LiveKit's HTTP and WebSocket port on, for your own proxy."},@@ -138,7 +138,7 @@ var envVars = []envVar{{"FLUXER_S3_READ_SIGNED", "storage", "Whether the media proxy signs its requests to FLUXER_S3_READ_ENDPOINT. Use `true` or `false`. Use `false` only for a bucket that allows anonymous downloads."},{"FLUXER_API_PRESIGNED_ATTACHMENT_UPLOADS_ENABLED", "storage", "Whether the API hands clients upload URLs that let them upload attachments before they send the message. Use `true` or `false`."},{"FLUXER_API_PRESIGNED_HARVEST_DOWNLOADS_ENABLED", "storage", "Whether data export and admin download links are presigned URLs to the object store. Use `true` or `false`. With `false`, the API serves those downloads itself. Turn it on only once browsers can connect to FLUXER_S3_PUBLIC_ENDPOINT."},- {"FLUXER_API_STORAGE_CHANGE_FEED_ENABLED", "storage", "Whether the api and worker services publish a record of each object store write and delete they make to a NATS JetStream stream. Uploads written by the media proxy relay or sent straight to the store by clients are not in it. Use `true` or `false`. When it's empty, the feed is off."},+ {"FLUXER_API_STORAGE_CHANGE_FEED_ENABLED", "storage", "Whether the api and worker services publish a record of each object store write and delete they make to a NATS JetStream stream. Uploads written by the media proxy relay or sent directly to the store by clients are not in it. Use `true` or `false`. When it's empty, the feed is off."},{"FLUXER_API_STORAGE_CHANGE_FEED_STREAM", "storage", "The JetStream stream the storage change feed publishes to, in letters, digits, underscores or hyphens. When it's empty, Fluxer uses STORAGE_CHANGES."},{"FLUXER_API_STORAGE_CHANGE_FEED_SKIP_BUCKETS", "storage", "Buckets the storage change feed leaves out, separated by commas, or `none` to leave out no bucket. When it's empty, the feed leaves out the uploads bucket."},{"FLUXER_SEAWEEDFS_INIT_ATTEMPTS", "storage", "How many rounds, about two seconds apart, the bundled object store's setup job tries to create the buckets and set up access before it gives up."},@@ -180,7 +180,7 @@ var envVars = []envVar{{"HTTP_PROXY", "network", "The api, worker and gateway don't use it."},{"HTTPS_PROXY", "network", "The api, worker and gateway don't use it."},{"NO_PROXY", "network", ""},- {"FLUXER_NODE_EXTRA_CA_CERTS", "network", "The path of a PEM file of CA certificates that the api and worker trust for outgoing TLS on top of Node's built-in ones. Use it when your email server has a certificate from your own CA. The path is inside their containers. With Docker Compose they see the ca folder of your instance at /etc/fluxer/ca, and nothing else from the instance folder. A file you set replaces the system bundle. Node's built-in CAs still apply, and the file can hold only your own CA. The Rust services don't use it and take their CA certificates from SSL_CERT_FILE."},+ {"FLUXER_NODE_EXTRA_CA_CERTS", "network", "The path of a PEM file of CA certificates that the api and worker trust for outgoing TLS on top of Node's built-in ones. Use it when your email server has a certificate from your own CA. The path is inside their containers. With Docker Compose they see the ca folder of your instance at /etc/fluxer/ca, and nothing else from the instance folder. A file you set replaces the system bundle. Node's built-in CAs still apply, and the file can have only your own CA. The Rust services don't use it and take their CA certificates from SSL_CERT_FILE."},{"FLUXER_SSO_ALLOW_PRIVATE_ADDRESSES", "sso", "Use `true` or `false`. When it's empty, Fluxer uses `false`."},{"FLUXER_PASSKEY_RP_ID", "sso", "The relying party ID that passkeys are tied to, a domain such as `chat.example.com`. When it's empty, Fluxer uses FLUXER_DOMAIN. Changing it makes every passkey registered against the old value stop working."},{"FLUXER_PASSKEY_RP_NAME", "sso", "The title browsers show for Fluxer when someone creates or uses a passkey. When it's empty, browsers show `Fluxer`."},@@ -227,7 +227,7 @@ var envVars = []envVar{{"FLUXER_PUSH_SERVICE_APNS_BASE_URL", "push", "A URL that replaces the APNs host in both environments, for a test double only. When it's empty, the push service uses Apple's own hosts."},{"FLUXER_PUSH_SERVICE_FCM_BASE_URL", "push", "The FCM host the push service sends to. When it's empty, it uses https://fcm.googleapis.com. Change it only for a proxy or a test double."},{"FLUXER_PUSH_SERVICE_MANAGED_RELAY_HOSTS", "push", "Hostnames, separated by commas, of the push relay that Fluxer runs. When it's empty, the push service uses `push.fluxer.com`. It sends to these hosts only once relay consent is accepted."},- {"FLUXER_PUSH_SERVICE_OWN_RELAY_HOSTS", "push", "Hostnames, separated by commas, of a push relay your instance runs itself. The push service sends mobile app notifications addressed to these hosts straight to APNs or FCM with its own credentials."},+ {"FLUXER_PUSH_SERVICE_OWN_RELAY_HOSTS", "push", "Hostnames, separated by commas, of a push relay your instance runs itself. The push service sends mobile app notifications addressed to these hosts directly to APNs or FCM with its own credentials."},{"FLUXER_PUSH_SERVICE_PRIVATE_HOSTS", "push", "Hostnames, separated by commas, that push endpoints may use even when they resolve to private or loopback addresses, such as a ntfy service on your own network. The push service refuses every other such endpoint."},{"FLUXER_PUSH_SERVICE_RELAY_CONSENT_ACCEPTED", "push", "Whether this push service accepts the push relay privacy notice, which lets it send through the relay Fluxer runs. Use `true`, `1` or `yes` to accept. With `false`, `0`, `no` or an empty value, the push relay setting of the instance decides."},{"FLUXER_CLAMAV_ENABLED", "media", "Whether Fluxer scans uploads for viruses with ClamAV. Use `true` or `false`. When it's empty, Fluxer uses `false`. No ClamAV container ships with the stack. Point FLUXER_CLAMAV_HOST at your own."},@@ -396,7 +396,7 @@ var envVars = []envVar{{"FLUXER_SEAWEEDFS_VOLUME_GROWTH", "tuning", "How many volumes SeaweedFS creates at once when a bucket has no writable volume left, set as its WEED_MASTER_VOLUME_GROWTH_COPY_1."},{"FLUXER_SEAWEEDFS_VOLUME_SIZE_LIMIT_MB", "tuning", "The size in MB a volume can grow to before SeaweedFS stops writing to it, set as its `-master.volumeSizeLimitMB`."},{"FLUXER_SEAWEEDFS_GARBAGE_THRESHOLD", "tuning", "The share of deleted space in a volume that makes SeaweedFS compact it, as a fraction, set as its `-master.garbageThreshold`."},- {"FLUXER_SEAWEEDFS_S3_CONCURRENT_UPLOADS", "tuning", "How many uploads the bundled object store writes at once, set as its `-s3.concurrentFileUploadLimit`. More uploads wait for a free slot. Each upload in progress holds up to 32 MB of memory in SeaweedFS. Raise FLUXER_SEAWEEDFS_MEMORY_LIMIT before you raise this."},+ {"FLUXER_SEAWEEDFS_S3_CONCURRENT_UPLOADS", "tuning", "How many uploads the bundled object store writes at once, set as its `-s3.concurrentFileUploadLimit`. More uploads wait for a free slot. Each upload in progress uses up to 32 MB of memory in SeaweedFS. Raise FLUXER_SEAWEEDFS_MEMORY_LIMIT before you raise this."},{"FLUXER_SEAWEEDFS_VOLUME_MAX", "tuning", "The most volumes the SeaweedFS volume store may have, set as its `-volume.max`."},{"FLUXER_SEAWEEDFS_INIT_MEMORY_LIMIT", "tuning", "The memory limit for the seaweedfs-init container, which creates the buckets, sets up the S3 key and the expiry of the uploads bucket, and then exits."},{"FLUXER_LIVEKIT_MEMORY_LIMIT", "tuning", "The memory limit for the livekit container."},diff --git a/fluxer_rexctl/internal/instance/shipped.json b/fluxer_rexctl/internal/instance/shipped.jsonindex 47403789a..e9247024a 100644--- a/fluxer_rexctl/internal/instance/shipped.json+++ b/fluxer_rexctl/internal/instance/shipped.json@@ -78,6 +78,7 @@"c913b93cb0115918750d80e1436fc0fcaaca0f30cda490596446de2ecdf4fe10","c9523547ceb490f1020b3201b0fed9e73c55f7c80b7f0905c7e19cbec8e52dc9","ca5f7c5e012a098428883e6286285011158cd3c6133f45dd4bb50d9b7db78245",+ "d0aeb34ffe32a0640c57dd7b879b3e901699cafb12f3a38965e6847663feaee2","d3a01fb8fe168f8690ea3beba3c24320ad66d47a7d6986a1a80d68b0c31aa969","d6a68661ec5f33dbbd38f11218e9df7a63186cb49a1fe90652e12918de09f7d2","daaf60c750e57fcac9a5048e3c9d95dc96300f9dc16e729ff4ff528efeeb35f7",diff --git a/fluxer_rexctl/internal/stack/files/.env.example b/fluxer_rexctl/internal/stack/files/.env.exampleindex aad757c5f..9f3d76541 100644--- a/fluxer_rexctl/internal/stack/files/.env.example+++ b/fluxer_rexctl/internal/stack/files/.env.example@@ -622,7 +622,7 @@ FLUXER_VAPID_PRIVATE_KEY=# Whether the api and worker services publish a record of each object store# write and delete they make to a NATS JetStream stream. Uploads written by-# the media proxy relay or sent straight to the store by clients are not in+# the media proxy relay or sent directly to the store by clients are not in# it. Use true or false. When it's empty, the feed is off.# rexctl: rexctl config set FLUXER_API_STORAGE_CHANGE_FEED_ENABLED# FLUXER_API_STORAGE_CHANGE_FEED_ENABLED=@@ -899,7 +899,7 @@ FLUXER_VAPID_PRIVATE_KEY=# With Docker Compose they see the ca folder of your instance at# /etc/fluxer/ca, and nothing else from the instance folder. A file you set# replaces the system bundle. Node's built-in CAs still apply, and the file-# can hold only your own CA. The Rust services don't use it and take their CA+# can have only your own CA. The Rust services don't use it and take their CA# certificates from SSL_CERT_FILE.# default: /etc/ssl/certs/ca-certificates.crt# rexctl: rexctl config set FLUXER_NODE_EXTRA_CA_CERTS@@ -1177,7 +1177,7 @@ FLUXER_VAPID_PRIVATE_KEY=# Hostnames, separated by commas, of a push relay your instance runs itself.# The push service sends mobile app notifications addressed to these hosts-# straight to APNs or FCM with its own credentials.+# directly to APNs or FCM with its own credentials.# rexctl: rexctl config set FLUXER_PUSH_SERVICE_OWN_RELAY_HOSTS# FLUXER_PUSH_SERVICE_OWN_RELAY_HOSTS=@@ -2230,7 +2230,7 @@ FLUXER_VAPID_PRIVATE_KEY=# How many uploads the bundled object store writes at once, set as its# -s3.concurrentFileUploadLimit. More uploads wait for a free slot. Each-# upload in progress holds up to 32 MB of memory in SeaweedFS. Raise+# upload in progress uses up to 32 MB of memory in SeaweedFS. Raise# FLUXER_SEAWEEDFS_MEMORY_LIMIT before you raise this. rexctl sizes this.# default: 5# rexctl: rexctl config set FLUXER_SEAWEEDFS_S3_CONCURRENT_UPLOADS