Skip to content

Commit

Permalink
libretranslate: clean up the comments and some unused options
Browse files Browse the repository at this point in the history
  • Loading branch information
jessebot committed Nov 17, 2024
1 parent efac318 commit 9c204ad
Showing 1 changed file with 49 additions and 39 deletions.
88 changes: 49 additions & 39 deletions libretranslate/app_of_apps/libre_translate_argocd_appset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,8 @@ spec:
models:
storageClass: ""
accessMode: "ReadWriteOnce"
size: "10Gi" # as of August 2023, the models are about 6.6GB in size for all languages
# as of August 2023, the models are about 6.6GB in size for all languages
size: "10Gi"

# Resource limits
resources:
Expand Down Expand Up @@ -147,10 +148,14 @@ spec:
# This is used by the nginx ingress controller to enable basic auth for the whole site.
# It will create a secret with the name libretranslate-auth.
adminUser:
name: "YWRtaW4K" # copy the username in base64 as a reference
auth: "YWRtaW46JGFwcjEkYlpydmYvUFYkSHBHSlhqZU1EN0ZON2kyYndsMVRNMQoK" # copy the output from the htpasswd command here as a reference
password: "bXlTZWNyZXRQYXNzd29yZAo=" # copy the password as base64 for the admin user here as a reference
existingSecret: "" # use an existing secret for admin user
# copy the username in base64 as a reference
name: "YWRtaW4K"
# copy the output from the htpasswd command here as a reference
auth: "YWRtaW46JGFwcjEkYlpydmYvUFYkSHBHSlhqZU1EN0ZON2kyYndsMVRNMQoK"
# copy the password as base64 for the admin user here as a reference
password: "bXlTZWNyZXRQYXNzd29yZAo="
# use an existing secret for admin user
existingSecret: ""
# key in existing secret
secretKeys:
name: "name"
Expand All @@ -160,25 +165,31 @@ spec:
# Settings / Flags
appSettings:
# Enable debug environment (Default: Disabled)
debug: "true"
debug: "true"
# Enable SSL (Default: Disabled)
ssl: "true"
# Enable API keys database for per-client rate limits when --req-limit is reached (Default: Don't use API keys)
apiKeys: "true"
# Require use of an API key for programmatic access to the API, unless the request origin matches this domain (Default: No restrictions on domain origin)
requireApiKeyOrigin: ""
# Require use of an API key for programmatic access to the API, unless the client also sends a secret match (Default: No secrets required)
requireApiKeySecret: ""
ssl: "true"
# Enable API keys database for per-client rate limits when
# --req-limit is reached (Default: Don't use API keys)
apiKeys: "true"
# Require use of an API key for programmatic access to the API,
# unless the request origin matches this domain
# (Default: No restrictions on domain origin)
requireApiKeyOrigin: ""
# Require use of an API key for programmatic access to the API,
# unless the client also sends a secret match
# (Default: No secrets required)
requireApiKeySecret: ""
# Allow user suggestions (Default: Disabled)
suggestions: "true"
suggestions: "true"
# Disable files translation (Default: File translation allowed)
disableFilesTranslation: "false"
# Disable web ui (Default: Web Ui enabled)
disableWebUi: "false"
# Update language models at startup (Default: Only on if no models found)
updateModels: "true"
# Enable the /metrics endpoint for exporting Prometheus usage metrics (Default: Disabled)
metrics: "false"
disableWebUi: "false"
# Update language models at startup
# (Default: Only on if no models found)
updateModels: "true"
# Enable the /metrics endpoint for exporting Prometheus usage
# metrics (Default: Disabled)
metrics: "false"
# use an existing secret for api key origin and secret
existingSecret: "libretranslate-api-key"
# keys in existing secret
Expand All @@ -188,22 +199,21 @@ spec:

# Configuration Parameters
appConfig:
host: "0.0.0.0" # Set host to bind the server to (Default: 127.0.0.1)
port: "5000" # Set port to bind the server to (Default: 5000)
charLimit: "null" # Set character limit (Default: No limit)
reqLimit: "null" # Set maximum number of requests per minute per client (outside of limits set by api keys) (Default: No limit)
reqLimitStorage: "memory://" # Storage URI to use for request limit data storage. See Flask Limiter (Default: memory://)
batchLimit: "null" # Set maximum number of texts to translate in a batch request (Default: No limit)
gaId: "" # Enable Google Analytics on the API client page by providing an ID (Default: Empty (no tracking))
frontendLanguageSource: "auto" # Set frontend default language - source (Default: auto)
frontendLanguageTarget: "locale" # Set frontend default language - target (Default: locale (match site's locale))
frontendTimeout: "500" # Set frontend translation timeout (Default: 500)
apiKeysDbPath: "/app/db/api_keys.db" # Use a specific path inside the container for the local database. Can be absolute or relative (Default: /app/db/api_keys.db)
apiKeysDbPathMount: "/app/db" # Use a specific path inside the container for the local database. Must be the same as apiKeysDbPath (Default: /app/db)
apiKeysRemote: "" # Use this remote endpoint to query for valid API keys instead of using the local database (Default: Empty (use local db instead))
getApiKeyLink: "" # Show a link in the UI where to direct users to get an API key (Default: Empty (no link shown on web ui))
sharedStorage: "memory://" # Shared storage URI to use for multi-process data sharing (e.g. when using gunicorn) (Default: memory://)
loadOnly: "" # Set available languages (Default: Empty (use all from argostranslate))
threads: "4" # Set number of threads (Default: 4)
metricsAuthToken: "" # Protect the /metrics endpoint by allowing only clients that have a valid Authorization Bearer token (Default: Empty (no auth required))
urlPrefix: "" # Add prefix to URL: example.com:5000/url-prefix/ (Default: /)
host: "0.0.0.0"
port: "5000"
charLimit: "null"
reqLimit: "null"
reqLimitStorage: "memory://"
batchLimit: "null"
gaId: ""
frontendLanguageSource: "auto"
frontendLanguageTarget: "locale"
frontendTimeout: "500"
apiKeysDbPath: "/app/db/api_keys.db"
apiKeysDbPathMount: "/app/db"
apiKeysRemote: ""
getApiKeyLink: ""
sharedStorage: "memory://"
loadOnly: ""
threads: "4"
metricsAuthToken: ""

0 comments on commit 9c204ad

Please sign in to comment.