The web console
The web console is the browser interface of Arkvory. It is part of the server, so you do not install it separately. Open /console/ on your server address, for example http://127.0.0.1:8080/console/ on the server itself, or https://arkvory.example/console/ after you set up HTTPS.
The console uses the same HTTP API as the command-line client and the SDK. The server checks every request. When a button is hidden, it only means that your account or key cannot use that operation.
Layout
The sidebar groups the sections. On a narrow screen, the sidebar becomes the Sections button.
| Group | Sections |
|---|---|
| Library | Artifacts, Packages, File history, Artifact details |
| Transfers | Upload, Downloads |
| Resources | Users and access, Repositories, Service access, Updates, Backups, Getting started, API & CLI |
The top bar shows the title of the section, the Upload file button, the Feedback button and the appearance and language controls.
Each section has its own address, such as #/catalog, #/packages or #/backups. An open artifact has the address #/artifact/<repository>/<id>. You can bookmark these addresses and send them to other people. The address never contains a password, a key or a search text. If you open a link before you sign in, the console opens it after you sign in.
Some sections appear only for some users:
| Section | Who sees it |
|---|---|
| Users and access | Administrators |
| Repositories | Everyone who is signed in |
| Service access | The recovery key, and operator keys with delegated rights |
| Updates | Administrators |
| Backups | Administrators and the recovery key |
Signing in
The Repository connection card is at the top of the page.
- Enter your Username and Password.
- Select Sign in. A session lasts 12 hours.
- The console selects the first Repository that you can read. To work in another repository, type its name or pick it from the list.
To connect with a key instead of a password, open Connect with a service or automation key, paste the key and select Connect. The key stays in the memory of this browser tab. The console never saves it.
Sign up appears only when the administrator allows self-registration. Disconnect ends the connection.
After you sign in with a password, you can use Change my password and Personal access tokens. A personal access token is a key for your own tools. See Accounts and access.
The first owner
A new installation has no accounts. On Windows, Setup creates the owner. On other installations, create the owner in the console:
- Open Getting started and expand Create the first owner.
- Paste the recovery key from
config/bootstrap-token.txtin the installation directory. - Enter a name and a password of at least 12 characters, then select Create owner.
- Sign in with the new name and password.
The form works only while there are no accounts. The owner is an administrator. The owner also gets write access to the releases repository through the arkvory-owners group.
Library
Artifacts
Artifacts lists the published files of the repository. Search by name or by a metadata value. Use Filter by label to show one label, and Exact metadata for an exact key and value. Each row shows the name, size, publication time, stages and labels. Select Download to download a file, or Open to see its details. Load more shows the next page.
Packages
Packages lists registered UPack versions. Filter by UPack group and Package name, choose Sort by and Group by, then select Apply. The stages column shows where each version is promoted. See Packages.
File history
A file path, such as builds/game/1.4/GameSetup.exe, can point to new content many times. Each change is a new version. In File history, enter a path and select Load history. You see each version with its author and time. You can open any version to download its original content. Restoring an old version creates a new version; it does not delete anything. See Files and paths.
Artifact details
Artifact details shows one artifact:
- Summary: Size, Uploaded and SHA-256 with a Copy button.
- Properties: Labels, Collections and Build metadata. Select Save changes to store them. The file itself does not change.
- Actions: Download; Download link creates a link that works for one hour without a key; Register UPack indexes a UPack archive.
- File reference: Assign file makes this artifact the current content of a file path.
- Promotion: Add stage marks the artifact with a stage, such as
qaorrelease. Promote publishes it in another repository. See Promotion. - Manifests & additional files: Add attachment links a manifest, SBOM, signature, report or other file to this build. Attachment history shows earlier sets.
- Delete artifact: Check dependencies shows what still uses the artifact. To delete, paste the artifact ID and select Delete this artifact. Deleting needs a service key that has the action
artifact.delete; a password sign-in, a personal token and the recovery key cannot delete.
Transfers
Upload
In Upload, choose a file and select Upload / resume. The console first computes the SHA-256 of the file, then sends it in parts. Pause stops the transfer and keeps the uploaded parts.
To continue later, keep the upload ID. Open Resume an upload, select the same file and enter the Upload ID. The browser warns you before you leave the page during an upload. See Transfers.
Downloads
Downloads is a queue of files that you download from the console. The console checks the SHA-256 of each file before it saves the final file.
- Queue settings sets Parallel downloads (1 to 8), Start interval, ms and Queue wait limit, seconds.
- Pause all, Resume queue, Cancel waiting, Cancel all and Remove finished control the whole queue.
- After a page reload, sign in again and select Restore queue. Then resume each file and choose where to save it.
Large downloads need Chrome or Edge on a secure address (HTTPS or the local computer). Temporary data stays in the private storage of the browser.
Resources
Users and access
Administrators manage people here. Accounts lists accounts; Groups and permissions lists groups. Use Create user, Reset password, Create group and Manage group members. In Manage repository access, give a group Read or Read and write access to a repository by name. A repository has no separate create step: it exists as soon as a grant or a service policy names it.
Repositories
Repositories shows the repositories that you can see, with Your permissions. Each card has Open files, Storage & cleanup (quota, automatic cleanup and physical cleanup; it needs a service key with the actions storage.read or storage.manage) and, for administrators, Manage access. A mirrored repository shows the Mirror badge. See Repositories and Storage.
Service access
Here you create accounts for tools and CI systems. To see this section, connect with the recovery key or with an operator key. Select Create service account, then set Repository permissions. Read preset and Publish preset fill typical permission sets.
To issue a key, open Service keys and select Issue key. The secret is shown only once. Copy it, confirm I have saved the secret and select Activate key. A key that is not activated expires after 15 minutes. Use Rotate to replace a key and Revoke to stop it. Delegated administration lets the owner give an operator limited administrative rights.
Updates
Updates shows the Installed version and the Latest stable release. Select Check now or Install update. In Automatic updates, turn on Install compatible stable releases automatically and choose the Maintenance hour (UTC). See Updates.
Backups
Backups shows whether backups are healthy, the latest backup, the next run, the backup agent and the backup storage. Select Create backup now to start a backup. Restore points lists restore points; you can verify every byte of a point or pin it. Schedule and retention sets the daily time, the time zone and how many points to keep. Restoring is a command on the server. See Backups.
Getting started and API reference
Getting started shows the first steps for a new server. API & CLI lists example commands. Load permitted API operations shows the API operations that your current account or key can call.
Feedback
After you sign in, Feedback sends a message to ProAnimaStudio through the hub. You can add up to 6 images and an email address for a reply. Administrators can attach the server log. Select Show what is attached to see exactly what is sent.
Appearance and language
Appearance has three options: System, Light and Dark. Language lists every language of the console by its own name: English, Русский, Español, Français, Deutsch, Português, 中文, 日本語, 한국어, हिन्दी and العربية. The page switches at once, without reloading and without losing what you typed; in Arabic it reads right to left. On the first visit the console follows the browser's languages and falls back to English. Documentation in API & CLI opens this documentation in the language of the console. The browser saves only the theme and the language, nothing about your account or repositories.