Warning
The product is in closed beta and not open to the public.
Deploy with Docker¶
Follow these steps to deploy VisionByte Server with Docker, create a repository, and enable file locking.
Prerequisites¶
Install Docker. Make sure port 8080 is available, or choose a different port when starting the server.
For a deployment with Docker Compose, see Deploy with Docker Compose.
Prepare the deployment¶
Download the image and prepare storage for your repository:
docker pull softbridge/vb-server:latest
docker volume create visionbyte-data
Create the repository¶
Create a repository named Demo:
docker run --rm -it \
--env VB_HOME=/museum \
--mount source=visionbyte-data,target=/museum \
--entrypoint /usr/local/bin/vb \
softbridge/vb-server:latest \
init --admin-user admin --project-name "Demo" /museum/demo.vbyte
The command prints the administrator account and initial password. Save them for your first login.
Start the server¶
docker run -d \
--name visionbyte-server \
--restart unless-stopped \
--env VB_HOME=/museum \
--publish 8080:8080 \
--mount source=visionbyte-data,target=/museum \
softbridge/vb-server:latest \
--jsmode inline --port 8080 /museum/demo.vbyte
To use another port, replace 8080:8080 with, for example, 28080:8080.
Check that visionbyte-server is running:
docker ps --filter name=visionbyte-server
If startup fails, inspect the logs:
docker logs visionbyte-server
Open http://localhost:8080/ and log in as admin with the initial
password. Use your chosen port if different, and the server hostname when
connecting from another machine.
To set a new administrator password, run:
docker exec -it visionbyte-server /usr/local/bin/vb user password admin -R /museum/demo.vbyte
Enter the new password when prompted.
Start PostgreSQL (optional)¶
To enable file locking, complete this section and the initialization step below. If you already have PostgreSQL available, proceed to initialization and use its connection details.
Prepare PostgreSQL:
docker network create visionbyte-net
docker network connect visionbyte-net visionbyte-server
docker volume create visionbyte-postgres-data
Create a file named postgres.env with the following contents, replacing
the example password with a strong password:
POSTGRES_USER=postgres
POSTGRES_PASSWORD=replace-with-postgres-admin-password
Start PostgreSQL:
docker run -d \
--name visionbyte-postgres \
--restart unless-stopped \
--network visionbyte-net \
--env-file postgres.env \
--mount source=visionbyte-postgres-data,target=/var/lib/postgresql \
postgres:18.7-alpine3.24
Check that PostgreSQL is ready:
docker exec visionbyte-postgres pg_isready -h 127.0.0.1 -U postgres -d postgres
Wait until the output reports accepting connections before continuing.
Initialize PostgreSQL for locks¶
Important
Run this initialization once for this server deployment. Do not repeat it after normal restarts.
Initialize the database. If using an existing PostgreSQL server, replace the host, port, and administrator username with its connection details:
docker exec -it visionbyte-server /usr/local/bin/vb pq init --host visionbyte-postgres --port 5432 --database visionbyte --admin-user postgres --runtime-user vb_runtime
Enter the two passwords when prompted:
PostgreSQL administrator password: the
POSTGRES_PASSWORDvalue inpostgres.env, or the password for your existing PostgreSQL server.VisionByte runtime password: a separate strong password for VisionByte to access the database.
Confirm that initialization prints:
PostgreSQL initialized for VisionByte database visionbyte.
Then verify the saved connection:
docker exec -it visionbyte-server /usr/local/bin/vb pq test
The output must include PostgreSQL connection OK. If either command
reports an error, resolve it and repeat the failed step before continuing.
For more information, see Deploy a Lock server.
Verify file locks¶
On a client connected to this repository, use a repository account with the required permissions and run the following commands in its working directory. Replace the example path with a tracked file:
vb lock Content/Hero.uasset
vb lock-info Content/Hero.uasset
vb unlock Content/Hero.uasset
The commands should report LOCK, show the lock information, and then report
UNLOCK.
For command options and examples, see lock, lock-info, and unlock.
Persistence and maintenance¶
To stop the server while keeping your data, run:
docker stop visionbyte-server
To start it again, run:
docker start visionbyte-server
If you started the PostgreSQL container, keep it running while using file locks.
Back up visionbyte-data, which contains your repository and saved
settings. If you enabled file locking, also back up your PostgreSQL database.
Warning
Deleting visionbyte-data or visionbyte-postgres-data
deletes its saved data. Back up your data before removing the deployment.