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
- A Linux server. For the Docker bundle, Docker with the Compose plugin (
docker compose versionshould work). For the native bundle, Linux x86_64 with Python 3.12 and systemd. - Network access from that server to your BIG-IP management address on HTTPS (443).
- A BIG-IP account for SVX to use (next section).
- Users reach SVX in a browser on port 5000 by default.
- No internet access is needed. Each bundle is self-contained.
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:
| Resource | Access |
|---|---|
ltm/virtual, ltm/pool, ltm/node | read, write, delete |
ltm/pool/members, ltm/virtual/*/profiles | read, write |
ltm/profile/http, tcp, udp, client-ssl | read, write, delete |
ltm/persistence/*, ltm/monitor/* | read, write, delete |
ltm/profile/server-ssl, ltm/rule | read |
ltm/virtual/stats, ltm/pool/stats, sys/cpu, sys/memory, sys/file/ssl-cert | read (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:
- F5_HOST, the BIG-IP management address.
- F5_USERNAME and F5_PASSWORD, the service account.
- F5_PARTITION, usually
Common. - PORTAL_TLS_HOSTNAMES, the names and addresses people will use to reach SVX, comma-separated. These go into its certificate.
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
- Open
https://<your-server>:5000. The first visit shows a certificate warning until you install your own certificate (next section). - 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. - 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.
- Save the backup codes it shows you. Each one works once, and they are how you get in if you lose your phone.
- 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
| Role | Can |
|---|---|
| Read-only | See the dashboard, the queue and every request. Change nothing. |
| Read/write | Raise requests, and review, push, reject and replicate them. |
| Admin | Everything 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
- 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. - Choose the protocol: HTTP, TCP or UDP.
- 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.
- Optionally choose a health monitor, iRules, a server SSL profile, or, for HTTP, a specific certificate instead of the standard one.
- For HTTP on port 443, tick Redirect port 80 to 443 to queue a separate redirect virtual server alongside it.
- 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:
| Object | Name | Example |
|---|---|---|
| Virtual server | {app}_{port}_vs | payroll_443_vs |
| Pool | {app}_{member port}_pool | payroll_8080_pool |
| Node | node_{address} | node_10.20.30.50 |
| Protocol profile | {app}_http, _tcp, _udp | payroll_http |
| Persistence | {app}_cookie_persistence or {app}_source_addr_persistence | |
| Client SSL (HTTP) | {app}.clientssl | payroll.clientssl |
| Health monitor | {app}_{parent}_monitor | payroll_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.
- Push. Select Push All to F5, or Push to Selected F5 when you have several devices. You must enter a change comment, such as a ticket number. Each card updates as it is applied. If a create fails partway, SVX removes whatever it had created, so nothing is left half-built.
- Reject. Select Reject and give a reason. The person who raised it sees the reason on the card. Nothing reaches the device.
- tmsh. Download the equivalent
tmshcommands for any request, to review it or apply it by hand. - History. Download the full request history as CSV or JSON: who asked, who approved, comments and outcomes. Clear Resolved tidies the page. The audit log keeps the permanent record.
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.
- Delete a virtual server. On the Dashboard, select the bin icon on its row. A preview lists what will be removed: the virtual server, its pool, nodes, and the profiles and monitor created for it. Anything still used by another virtual server is listed as kept. Confirming adds a delete request to the queue, and nothing is removed until it is pushed.
- Undo a push. On a pushed queue card, select Undo Push. That queues a delete request for exactly what the push created, on the device it went to.
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
- Each virtual server shows its status, connections and throughput. Expand a row to see its pool and each node’s health.
- The summary cards filter the list: Available, Unavailable, or Pools degraded (some pool members down). Select a card again to clear the filter. The search box matches names, addresses and nodes.
- Top 5 lists show the busiest virtual servers by connections and by throughput. Device CPU and memory are shown too.
- The Certificates card lists the certificates installed on the device, soonest to expire first. Under 14 days is red and under 30 days is amber.
- CSV, JSON and Print export exactly what is on screen. The dashboard refreshes when you select Refresh or change device.
15. Users & two-factor
- Add users. Admins open Users to add accounts as read-only or read/write, change roles, reset passwords, and remove accounts.
- New phone. Open Account and select Reconfigure / new QR code. Your old authenticator keeps working until you confirm a code from the new one.
- Lost phone. Sign in with one of your backup codes, in the form
xxxxx-xxxxx, in the code box, then reconfigure. You can issue a fresh set of codes from Account at any time. - No phone and no codes. An admin can reset that person’s two-factor from Users. They then set it up again at their next sign-in.
16. Branding & logs
- Branding. Upload your own logo, as PNG, JPEG, GIF, WebP or SVG up to 512 KB. It appears in the top bar and on the sign-in page.
- Logs. View the audit log and the application log in the browser. The audit log records every sign-in, request, approval, rejection and change made to a device, with who did it and when. Both are also files on the server under
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:
| Path | Holds |
|---|---|
.env | BIG-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
.envor on the Devices page work. Then use Test on the Devices page. - The BIG-IP GUI shows the default
tcpprofile on a virtual server SVX created. - This is a known F5 GUI bug (ID 914493). The GUI shows
tcpwhatever is attached. Check withtmsh 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_KEYin.envis 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.