In order to set endpoints with specific access permissions, you can configure the users key with a list of user objects. Each user object should contain the username, password, and their respective permissions.
Example: This example illustrates the configuration for two users: an admin user with full permissions (*) and a reader user with limited permissions to specific read-only endpoints.
In order to set endpoints with public access, you can configure the public_endpoints key with a list of endpoint objects. Each endpoint object should specify the path and method of the endpoint.
Example: This example demonstrates the configuration for public endpoints, allowing access without authentication to read-only endpoints.
Related Issue(s):
Description:
Basic Auth
Environment Variable Configuration
Basic authentication is an optional feature. You can enable it by setting the environment variable
BASIC_AUTH
as a JSON string.Example:
User Permissions Configuration
In order to set endpoints with specific access permissions, you can configure the
users
key with a list of user objects. Each user object should contain the username, password, and their respective permissions.Example: This example illustrates the configuration for two users: an admin user with full permissions (*) and a reader user with limited permissions to specific read-only endpoints.
Public Endpoints Configuration
In order to set endpoints with public access, you can configure the public_endpoints key with a list of endpoint objects. Each endpoint object should specify the path and method of the endpoint.
Example: This example demonstrates the configuration for public endpoints, allowing access without authentication to read-only endpoints.
Docker Compose Configurations
See
docker-compose.basic_auth_protected.yml
anddocker-compose.basic_auth_public.yml
for basic authentication configurations.PR Checklist:
pre-commit run --all-files
)make test
)