rexctl commands

This page is made from the help that rexctl prints, and rexctl <command> --help shows the same text in the terminal.

Flags for every command

--dir string

Folder with your instance.
-q, --quiet

Print only errors and results.
--verbose

Print every step and command.
-y, --yes

Answer yes to every question and never prompt.

rexctl admins

Choose who can manage your instance.

rexctl admins add

Make an account an admin.

rexctl admins add <user>

rexctl admins remove

Remove admin access from an account.

rexctl admins remove <user>

Print a link that signs an admin in once.

rexctl admins sign-in-link <user>

rexctl backup

Back up your instance. Fluxer pauses while uploads are copied.

rexctl backup

rexctl backup keep

Show or change how many backups rexctl keeps. After each backup, rexctl deletes the oldest ones beyond this number, except the backup that rexctl rollback needs. Pass all to keep every backup.

rexctl backup keep [count|all] [flags]

--json

Print JSON.

rexctl backup list

List your backups.

rexctl backup list [flags]

--json

Print JSON.

rexctl backup location

Show the folder rexctl saves backups in, or pass a full path to save new backups there. Backups that are already saved stay where they are.

rexctl backup location [folder] [flags]

--json

Print JSON.

rexctl backup verify

Check that a backup is complete and readable.

rexctl backup verify <file>

rexctl branding

Change your instance’s name, colour and images.

rexctl branding set

Change the name, colour, logo or icon.

rexctl branding set [flags]

--colour string

Accent colour as a hex code, like #4641d9.
--icon string

Image file for the icon.
--logo string

Image file for the logo.
--name string

Your instance’s name.

rexctl config

Read and change Fluxer’s settings.

rexctl config get

Show one setting.

rexctl config get <key> [flags]

--json

Print JSON.
--reveal

Print a secret rexctl keeps.

rexctl config list

List every setting with its value and help.

rexctl config list [flags]

--all

Also list every raw setting and the secrets rexctl generated.
--json

Print JSON.

rexctl config set

Change one or more settings.

rexctl config set <key> <value> | <key>=<value>...

rexctl config unset

Go back to the default for one or more settings.

rexctl config unset <key>...

rexctl doctor

Check your instance and this machine for problems.

rexctl doctor [flags]

--fix

Fix the problems rexctl can fix safely.
--json

Print JSON.

rexctl eject

Writes every setting into the instance folder for docker compose and stops rexctl from changing the instance. Fluxer keeps running. Run rexctl takeover to hand it back.

rexctl eject

rexctl email

Set up how your instance sends email.

rexctl email off

Stop sending email.

rexctl email off

rexctl email set

Set the SMTP server.

rexctl email set [flags]

--from string

Sender, like Example Chat <noreply@chat.example.com>.
--host string

The SMTP server.
--password-file string

File with the SMTP password, or - for stdin.
--port int

The SMTP port. The default is 587.
--tls string

How the connection is encrypted (starttls, implicit, opportunistic or none). Picked from the port when left out.
--username string

The username for the SMTP server.

rexctl email test

Send a test email.

rexctl email test [address]

rexctl install

Install Fluxer on this machine, or take over an existing install.

rexctl install [flags]

--admin-email string

Email address for your admin account.
--admin-password-file string

File with your admin password, or - for stdin.
--admin-username string

Username for your admin account.
--behind-proxy

Serve plain HTTP for your own reverse proxy.
--bind string

Address your proxy connects to, with —behind-proxy. The default is 127.0.0.1:8080.
--confirm string

Your instance’s domain, to confirm without a prompt.
--delete-old-data

Delete Fluxer data found on this machine and start fresh.
--domain string

Address people will use to open your instance, like chat.example.com.
--dry-run

Show what would happen without changing anything.
--engine string

Container engine to use (docker or podman).
--install-docker

Install Docker if it’s missing. The default is true.
--memory-profile string

Pin small, medium or large instead of sizing Fluxer to this machine on every start.
--name string

Your instance’s name.
--no-start

Write the files without starting Fluxer.
--open-firewall

Open the ports Fluxer needs in ufw or firewalld. The default is true.
--registration string

Who can create an account (invite, approval, open or closed).
--setup string

Where to create your admin account (terminal or browser).
--setup-podman

Start Podman’s API socket and start Fluxer with the machine. The default is true.
--sign-in string

How people sign in (email or username).
--skip-email

Set up email later.
--smtp-from string

Sender, like Example Chat <noreply@chat.example.com>.
--smtp-host string

The SMTP server.
--smtp-password-file string

File with the SMTP password, or - for stdin.
--smtp-port int

The SMTP port. The default is 587.
--smtp-tls string

How the connection is encrypted (starttls, implicit, opportunistic or none). Picked from the port when left out.
--smtp-username string

The username for the SMTP server.
--storage-access-key string

The object store access key.
--storage-bucket-prefix string

Text to put before each bucket name, like chat- for chat-fluxer.
--storage-endpoint string

Your own S3-compatible object store, like https://s3.example.com, instead of the bundled one.
--storage-path-style

Put the bucket in the path of object store addresses instead of the host name. The default is true.
--storage-public-endpoint string

The object store address browsers use, when it differs from —storage-endpoint.
--storage-region string

The object store region (found from —storage-endpoint when it can be).
--storage-secret-key-file string

File with the object store secret key, or - for stdin.
--take-over

Take over Fluxer data found on this machine.
--voice-ip string

Public IP address for voice and video (found automatically).

rexctl invites

Manage invite links for new accounts.

rexctl invites create

Create an invite link.

rexctl invites create [flags]

--expires string

How long the link works, like 12h, 7d or never. The default is 7d.
--label string

A note to help you recognise the link.
--uses int

How many people can use the link, or 0 for no limit. The default is 1.

rexctl invites list

List invite links.

rexctl invites list [flags]

--json

Print JSON.

rexctl invites revoke

Stop an invite link from working.

rexctl invites revoke <id>

rexctl logs

Show logs from your instance.

The services are web, api, worker, gateway, voice, media, edge, admin, push, database, search, storage, cache, queue and internal. Without a service, rexctl shows every service.

rexctl logs [service] [flags]

-f, --follow

Keep printing new lines.
--since string

Show lines newer than this, like 10m or 2h.

rexctl proxy

Use your own reverse proxy in front of Fluxer.

rexctl proxy off

Serve HTTPS directly with a certificate from Let’s Encrypt.

rexctl proxy off

rexctl proxy on

Serve plain HTTP for your own proxy.

rexctl proxy on [flags]

--bind string

Address your proxy connects to. The default is 127.0.0.1:8080.

rexctl registration

Choose who can create an account.

rexctl registration approve

Approve a person waiting for approval.

rexctl registration approve <id>

rexctl registration deny

Turn down a person waiting for approval.

rexctl registration deny <id>

rexctl registration pending

List people waiting for approval.

rexctl registration pending [flags]

--json

Print JSON.

rexctl registration set

Set who can create an account.

rexctl registration set <open|approval|invite|closed>

rexctl restart

Restart your instance.

rexctl restart

rexctl restore

Restore your instance from a backup. This works on a new machine too. Copy the backup file there and run this command.

rexctl restore <file> [flags]

--confirm string

Your instance’s domain, to confirm without a prompt.
--engine string

Move the instance to another engine while restoring (docker).

rexctl rollback

Go back to the release you ran before the last upgrade.

rexctl rollback [flags]

--confirm string

Your instance’s domain, to confirm without a prompt.
--dry-run

Show what would happen without changing anything.
--restore-database

Also restore the database from the backup taken before the upgrade.

rexctl setup

Create the admin account and finish setup in the terminal.

rexctl setup [flags]

--admin-email string

Email address for your admin account.
--admin-password-file string

File with your admin password, or - for stdin.
--admin-username string

Username for your admin account.
--name string

Your instance’s name.
--registration string

Who can create an account (invite, approval, open or closed).
--sign-in string

How people sign in (email or username).
--skip-email

Set up email later.
--smtp-from string

Sender, like Example Chat <noreply@chat.example.com>.
--smtp-host string

The SMTP server.
--smtp-password-file string

File with the SMTP password, or - for stdin.
--smtp-port int

The SMTP port. The default is 587.
--smtp-tls string

How the connection is encrypted (starttls, implicit, opportunistic or none). Picked from the port when left out.
--smtp-username string

The username for the SMTP server.

rexctl setup token

Show the setup token for the browser.

rexctl setup token

rexctl start

Start your instance.

rexctl start

rexctl status

Show whether your instance is running.

rexctl status [flags]

--json

Print JSON.

rexctl stop

Stop your instance.

rexctl stop

rexctl takeover

Hands an instance made by the old installer, by hand with docker compose, or released with rexctl eject over to rexctl. Fluxer keeps running as it is.

rexctl takeover [flags]

--dry-run

Show what would change without changing anything.

rexctl uninstall

Remove Fluxer from this machine.

rexctl uninstall [flags]

--confirm string

Your instance’s domain, to confirm without a prompt.
--keep-data

Keep your data and backups.

rexctl upgrade

Upgrade rexctl and Fluxer to the latest release.

rexctl upgrade [flags]

--check

Show whether an upgrade is available without changing anything.
--dry-run

Show what would happen without changing anything.
--json

Print JSON.
--no-backup

Skip the backup before upgrading.
--prefetch

Download the new version and upgrade later.
--to string

Upgrade to this version, not the latest.

rexctl users

Manage accounts on your instance.

rexctl users ban

Ban an account.

rexctl users ban <user> [flags]

--delete-messages

Also delete their messages.
--reason string

Why you’re banning them, one of spam, scam, harassment, hate, threats, raids, automation, ban-evasion, impersonation, malware, doxxing, intimate-images, explicit-content, adult-content, violence, self-harm, illegal, deception, exploits or report-abuse.

rexctl users create

Create an account and print a link to set its password.

rexctl users create <username> [flags]

--admin

Make the account an admin.
--email string

Email address for the account.

rexctl users delete

Delete an account and its data.

rexctl users delete <user> [flags]

--confirm string

Your instance’s domain, to confirm without a prompt.

rexctl users disable-mfa

Turn off two-factor authentication for an account.

rexctl users disable-mfa <user>

rexctl users list

List accounts.

rexctl users list [flags]

--admins

Only show admins.
--json

Print JSON.
--search string

Only show accounts that match this text.

rexctl users reset-link

Print a link to set a new password.

rexctl users reset-link <user>

rexctl users show

Show one account.

rexctl users show <user> [flags]

--json

Print JSON.

rexctl users sign-out

Sign an account out everywhere.

rexctl users sign-out <user>

rexctl users unban

Lift a ban.

rexctl users unban <user>

rexctl version

Show the rexctl and Fluxer versions.

rexctl version [flags]

--json

Print JSON.