Sign inSign up

borndigital/handle

By borndigital

•Updated about 2 years ago

Image
0

1.2K

borndigital/handle repository overview

⁠Handle

Docker image for Handle⁠ version 9.3.0.

Please refer to the Handle Documentation⁠ for more in-depth information.

As a quick example this will bring up an instance of Handle⁠, and allow you to view on http://localhost:8000/⁠.

docker run --rm -ti -p 8000:8000 islandora/handle

⁠Dependencies

Requires islandora/java docker image to build. Please refer to the Java Image README⁠ for additional information.

⁠Ports

PortDescription
8000 (tcp)Port 8000 offers an HTTP and HTTPS interface.
2641 (udp/tcp)Port 2641 (UDP and TCP) is the IANA-assigned port number for the Handle wire protocol.

⁠Settings

⁠Confd Settings
Environment VariableDefaultDescription
HANDLE_ADMIN_FULL_ACCESSyes"yes" or "no". If set to "no" the "server_admins" will have default permissions at the prefix level
HANDLE_ADMIN_PRIVATE_KEY_PEMSee rootfs/etc/defaults/HANDLE_ADMIN_PRIVATE_KEY_PEMPlease read the handle documentation for how this is use
HANDLE_ADMIN_PUBLIC_KEY_PEMSee rootfs/etc/defaults/HANDLE_ADMIN_PUBLIC_KEY_PEMPlease read the handle documentation for how this is use
HANDLE_ALLOW_NA_ADMINSyes"yes" or "no". Allow admins from GHR?
HANDLE_CASE_SENSITIVEno"yes" or "no". Whether or not handles are case sensitive
HANDLE_DB_NAMEhandleThe name of the handle database
HANDLE_DB_PASSWORDpasswordThe database users password
HANDLE_DB_READONLYnoA boolean setting (can be "yes" or "no") prevent / allow database modification
HANDLE_DB_USERhandleThe database user
HANDLE_MAX_AUTH_TIME60000The number of seconds to wait for a client to respond to an authentication challenge
HANDLE_MAX_SESSION_TIME86400000Time in milliseconds that an authenticated client session can persist
HANDLE_PREFIX200Please read the handle documentation for how this is use
HANDLE_PRIVATE_KEY_PEMSee rootfs/etc/defaults/HANDLE_PRIVATE_KEY_PEMPlease read the handle documentation for how this is use
HANDLE_PUBLIC_KEY_PEMSee rootfs/etc/defaults/HANDLE_PUBLIC_KEY_PEMPlease read the handle documentation for how this is use
HANDLE_SERVER_ID1Used to distinguish from other servers within the same site
HANDLE_PERSISTENCE_TYPEbdbjeCan be 'sql', if 'bdbje' make sure to create a volume at /var/handle/bdbje to persist changes
HANDLE_TEMPLATE_NS_OVERRIDEnoPrefer server_config settings.

Note: For PEM files the private key must conform to PKCS#8⁠ and not PKCS#1⁠ as the tools which do key conversion into the handle format do not support PKCS#1.

i.e PEM files which begin with -----BEGIN RSA PRIVATE KEY----- are not supported only keys which start with -----BEGIN PRIVATE KEY----- or -----BEGIN ENCRYPTED PRIVATE KEY----- are supported. Note if you use encrypted keys you will need to handle the decryption of them as it is not handled by this image at this time.

⁠Database Settings

Handle⁠ can optionally make use of different database backends for storage. Please see the documentation in the base image⁠ for more information about the default database connection configuration.

The following settings are only used if HANDLE_PERSISTENCE_TYPE is set to mysql or postgresql.

Environment VariableDefaultDescription
HANDLE_DB_NAMEhandleThe name of the database
HANDLE_DB_USERhandleThe user to connect to the database
HANDLE_DB_PASSWORDpasswordThe password of the user used to connect to the database

Additionally the DB_DRIVER variable is derived from the HANDLE_PERSISTENCE_TYPE so users do not need to specify it separately.

Tag summary

Content type

Image

Digest

sha256:7822619a5…

Size

253.4 MB

Last updated

about 2 years ago

docker pull borndigital/handle:matomo-upgrade-511