Setup and user guide

Install SVX, connect it to your BIG-IP, and put it to work. Setup takes about ten minutes; the second half covers day-to-day use.

1. Requirements

2. BIG-IP service account

SVX makes every change with one iControl REST account, held on the SVX server. Your users never log in to the BIG-IP. Create a dedicated account with access to the partition SVX will manage. It needs:

ResourceAccess
ltm/virtual, ltm/pool, ltm/noderead, write, delete
ltm/pool/members, ltm/virtual/*/profilesread, write
ltm/profile/http, tcp, udp, client-sslread, write, delete
ltm/persistence/*, ltm/monitor/*read, write, delete
ltm/profile/server-ssl, ltm/ruleread
ltm/virtual/stats, ltm/pool/stats, sys/cpu, sys/memory, sys/file/ssl-certread (dashboard)

SVX only ever deletes objects it created and that nothing else uses. The delete rights are what make that clean-up possible.

3. Install with Docker

Download the Docker bundle, copy it to the server, and run:

tar xzf svx-docker.tar.gz
cd fp-f5-ss-*/
./install.sh

The installer loads the bundled image and asks for:

It then creates the admin account, generates a TLS certificate, and starts SVX. Your answers are saved in .env, which you can edit later. Afterwards, run docker compose restart.

To check it is running:

docker compose ps
docker compose logs -f

4. Install without Docker

Use the native bundle on hosts that can’t run containers, such as unprivileged LXC containers. It needs Linux x86_64 with Python 3.12. The installer refuses any other Python version.

tar xzf svx-native.tar.gz
cd fp-f5-ss-*/
./install.sh

It asks the same questions as the Docker install. It then builds a private Python environment from the bundled packages, offline, and installs a fp-f5-ss systemd service, which needs sudo. You don't need to install any OS packages first.

sudo systemctl status fp-f5-ss
sudo systemctl restart fp-f5-ss     # after editing .env
journalctl -u fp-f5-ss -f           # live logs

5. First sign-in

  1. Open https://<your-server>:5000. The first visit shows a certificate warning until you install your own certificate (next section).
  2. Sign in as admin. The installer prints the password once and also saves it to .initial_admin_credentials. Note it down, then delete that file.
  3. SVX asks you to set up two-factor authentication, which is required for any account that can change a device. Scan the QR code with an authenticator app such as Microsoft Authenticator, Google Authenticator or 1Password, then enter the 6-digit code.
  4. Save the backup codes it shows you. Each one works once, and they are how you get in if you lose your phone.
  5. Change the admin password under Account, the person icon in the top bar.

6. Address & certificate

SVX serves HTTPS itself. On first start it creates a self-signed certificate for the names in PORTAL_TLS_HOSTNAMES. To change those names later, edit .env, delete the old certificate, and restart:

rm certs/portal.*
docker compose restart          # native: sudo systemctl restart fp-f5-ss

To use your own certificate, copy it into place. SVX never overwrites an existing pair.

cp fullchain.pem certs/portal.crt
cp privkey.pem   certs/portal.key
chmod 600 certs/portal.key
docker compose restart

To use a different port, set PORTAL_PORT=8443 in .env and run docker compose up -d.

7. Licence

Every install starts a 30-day trial of the full product on first run. Admins see the days remaining in the top bar, and a warning appears in the last 14 days. When the trial or licence ends, SVX shows a licence page and stops serving requests. Nothing on your BIG-IP is touched, and your queue, users and devices are kept.

To license it, copy the key you were sent into config/license.key. SVX picks it up within a minute, or you can restart it. Keys are checked offline on your server. Nothing calls home.

8. More BIG-IP devices

The device you gave the installer is the primary. To manage more, an admin opens Devices and selects Add device. Enter its address, partition and its own username and password, then select Test to check the connection before saving. Device passwords are stored on the server and never shown in the browser.

To limit which addresses can be added, set F5_ALLOWED_HOSTS in .env to a list of networks or names, for example 10.20.0.0/16,.lb.example.com.

With more than one device, the request form and the queue each show a device selector.

9. Roles

RoleCan
Read-onlySee the dashboard, the queue and every request. Change nothing.
Read/writeRaise requests, and review, push, reject and replicate them.
AdminEverything above, plus users, devices, branding and logs.

Read/write and admin accounts must use two-factor. The admin role can only be granted in config/users.yml on the server, never from the browser.

10. Request a virtual server

  1. Open New Virtual Server and type the application name, for example payroll. The rest of the form appears once it has a name, because every object is named from it.
  2. Choose the protocol: HTTP, TCP or UDP.
  3. Enter the virtual server address and port, then add the pool members, each an address and a port. Pick existing nodes or type new addresses.
  4. Optionally choose a health monitor, iRules, a server SSL profile, or, for HTTP, a specific certificate instead of the standard one.
  5. For HTTP on port 443, tick Redirect port 80 to 443 to queue a separate redirect virtual server alongside it.
  6. Select Add to Queue. Nothing is sent to the BIG-IP yet. Repeat to stack up more requests.

Names are generated for you as you type:

ObjectNameExample
Virtual server{app}_{port}_vspayroll_443_vs
Pool{app}_{member port}_poolpayroll_8080_pool
Nodenode_{address}node_10.20.30.50
Protocol profile{app}_http, _tcp, _udppayroll_http
Persistence{app}_cookie_persistence or {app}_source_addr_persistence
Client SSL (HTTP){app}.clientsslpayroll.clientssl
Health monitor{app}_{parent}_monitorpayroll_http_monitor

11. Review & push

The Queue shows every request, newest first, with the complete configuration it will create. That covers the pool and members, the monitor, and every profile, each marked will create, existing or built-in. Coloured edges show status: amber pending, green pushed, red failed, grey rejected.

12. Replicate to another device

To build the same service on a second BIG-IP, select Replicate on a queue card. Choose the target device and enter the new virtual server address. Then enter new addresses for any pool members that differ; leave a member blank to keep its address. You can also add members. The copy is queued as a new request for review and push like any other.

13. Delete & undo

Deletes go through the queue too.

The plan is checked against the device again at push time, so something attached elsewhere since the request was raised is never removed.

14. Dashboard

15. Users & two-factor

16. Branding & logs

17. Upgrade & roll back

Download the new bundle, copy it to the server, and run this from your existing install folder:

./upgrade.sh --bundle /path/to/svx-docker.tar.gz

It verifies the bundle’s checksums, snapshots your data, configuration and certificates, keeps the old version for rollback, upgrades, and confirms the new version started. Your settings, users, queue and licence are kept. If anything is wrong:

./upgrade.sh --rollback

Run it with sudo if the snapshot reports files it could not read, so the backup is complete. To make your own changes to the Compose setup, put them in docker-compose.override.yml, which upgrades never touch.

18. Backup

Everything that makes an install yours lives in a few places. Back these up and you can rebuild it anywhere:

PathHolds
.envBIG-IP connection, secret key, TLS settings
config/Admin accounts, licence key, naming rules, pinned devices
data/Queue and history, users and two-factor added in the browser, devices, logo
certs/TLS certificate and key
logs/Audit and application logs

.env, data/ and certs/ hold passwords and keys. Keep backups somewhere only administrators can read.

19. Troubleshooting

The browser warns about the certificate.
That is the self-signed certificate. Install your own (section 6), or make sure the name you browse to is in PORTAL_TLS_HOSTNAMES.
The dashboard or the request form shows a device error.
SVX can’t reach the BIG-IP or the account was refused. Check that the server reaches the management address on 443, and that the credentials in .env or on the Devices page work. Then use Test on the Devices page.
The BIG-IP GUI shows the default tcp profile on a virtual server SVX created.
This is a known F5 GUI bug (ID 914493). The GUI shows tcp whatever is attached. Check with tmsh list ltm virtual <name> profiles. Avoid clicking Update on that virtual server in the GUI, because it saves back what it displays.
I’ve lost my authenticator.
Use a backup code (section 15). If you have none left, ask an admin to reset your two-factor.
Everyone was signed out after a restart.
Make sure FLASK_SECRET_KEY in .env is set to a long random value. The installer sets one, so check it hasn't been removed.
Something else.
Check the Logs page or logs/portal.log, then email info@ddrcomputing.co.uk with your version, shown next to the SVX name in the top bar.

Back to top · Download SVX