Administration
This page is intended for system administrators, to document common tasks and tips needed to efficiently manage an Arkindex instance.
File storage¶
Arkindex requires the following S3-API buckets to store various files:
Configuration | Default name | Description |
---|---|---|
s3.staging_bucket |
staging | Staging area where user uploaded files are stored before validation |
s3.export_bucket |
export | SQLite databases generated by the project export task |
s3.thumbnails_bucket |
thumbnails | Folder thumbnails generated by the thumbnails generation worker |
s3.training_bucket |
training | Machine Learning models |
s3.ponos_artifacts_bucket |
ponos-artifacts | Artifact files produced by processes |
s3.ponos_logs_bucket |
ponos-logs | Log files for all tasks of all processes |
N/A | iiif-cache | (Optional) Bucket used by the Cantaloupe IIIF server to cache image renderings |
N/A | uploads | (Optional) Bucket used by the Cantaloupe IIIF server to expose locally uploaded images |
You can create these buckets on MinIO or any other S3-API compatible service by using the MinIO Client (open-source):
# Login on your provider by creating an alias
mc alias set arkindex-s3 <URL> <LOGIN> <PASSWORD>
# Create required buckets by prefixing them with the alias name
mc mb arkindex-s3/staging
mc mb arkindex-s3/export
...
Administration interface¶
As an administrator, you can use the administration interface on your Arkindex instance, available at https://<INSTANCE_URL>/admin/
(for example, if your instance lives at ark.localhost
, you’ll be able to use the interface here).
Warning
Beware of your actions on this interface: you can delete most items in the Arkindex database, without any rights checks. You are an administrator: with great power comes great responsibility.
User creation and management¶
By clicking on the Users > Users link from the main page, you’ll reach the user management. From there you can:
- create new users
- promote an existing user to administrator
- change user email & display name
- change their password
- disable their account
- delete their account
Project management¶
By clicking on the Documents > Corpora link from the main page, you’ll reach the project management (projects are internally named corpus). From there you can:
- create a new empty corpus
- change corpus attributes (name, description, …)
- make the corpus fully public
- make the corpus search indexed
- delete a corpus
Asynchronous tasks¶
This page is not linked from the main administration page, and is only reachable by using the link https://<INSTANCE_URL>/rq/
From that page, you can view all the asynchronous queues, current tasks and active workers.
System worker management¶
While the recommended way to manage Arkindex system workers is to let the arkindex update_system_workers
command configure the recommended worker versions, it is possible to manage them manually through the administration interface.
Under Process → Worker versions, the worker version management page includes a feature filter, which makes it easier to find the worker version that implements a specific feature.
To assign or unassign a feature on a worker version:
- Click on the UUID of the worker version in the list.
- Set or unset a feature in the Feature field.
- Click on Save.
Only one worker version can provide an Arkindex feature at once. To assign an already assigned feature to another version, you will need to first unassign the feature from the current version, then assign it to the new version. If a version was already assigned to a feature, saving will show an error.
Warning
Arkindex expects that the worker versions providing features meet the following conditions:
- Their state must be Available.
- They must not require a GPU.
- They must not require a model version to be set.
- They must not have required fields in their user configuration.
When those conditions are not met, imports and Workers processes may not work correctly.
arkindex update_system_workers
verifies those conditions automatically.