|
1 | 1 | # filebrowser |
2 | 2 |
|
3 | | -   |
4 | | - |
5 | | -A Helm chart for File Browser - A web-based file management interface with OAuth2 authentication |
| 3 | +A Helm chart for the File Browser project |
6 | 4 |
|
7 | 5 | **Homepage:** <https://filebrowser.org> |
8 | 6 |
|
9 | | -## Maintainers |
| 7 | +## Introduction |
10 | 8 |
|
11 | | -| Name | Email | Url | |
12 | | -| ---- | ------ | --- | |
13 | | -| SAS Institute | <[email protected]> | <https://www.sas.com> | |
| 9 | +This chart packages the project **[filebrowser](https://filebrowser.org)** as a Helm chart. |
14 | 10 |
|
15 | | -## Source Code |
| 11 | +## Parameters |
16 | 12 |
|
17 | | -* <https://github.com/filebrowser/filebrowser> |
| 13 | +The following tables lists the configurable parameters of the chart and their default values. |
18 | 14 |
|
19 | 15 | ## Values |
20 | 16 |
|
21 | 17 | | Key | Type | Default | Description | |
22 | 18 | |-----|------|---------|-------------| |
23 | | -| affinity | object | `{"nodeAffinity":{"preferredDuringSchedulingIgnoredDuringExecution":[{"preference":{"matchExpressions":[{"key":"sas.com/deployment","operator":"In","values":["sas-retrieval-agent-manager"]}]},"weight":1},{"preference":{"matchExpressions":[{"key":"workload.sas.com/class","operator":"In","values":["ram"]}]},"weight":2}]}}` | Map of node/pod affinities | |
24 | | -| config | object | `{"address":"","baseURL":"/files","database":"/db/filebrowser.db","log":"stdout","port":18080,"root":"/mnt/data"}` | File Browser application specific configuration | |
25 | | -| config.address | string | `""` | Address to bind the server to (empty means all interfaces) | |
26 | | -| config.baseURL | string | `"/files"` | Base URL path for the filebrowser application | |
27 | | -| config.database | string | `"/db/filebrowser.db"` | Path to the SQLite database file for storing filebrowser configuration | |
28 | | -| config.log | string | `"stdout"` | Log output destination (stdout, stderr, or file path) | |
29 | | -| config.port | int | `18080` | Port on which the filebrowser application listens inside the container | |
30 | | -| config.root | string | `"/mnt/data"` | Root directory that filebrowser will serve and manage files from | |
31 | | -| db | object | `{"pvc":{"accessModes":["ReadWriteOnce"],"enabled":true,"size":"256Mi","storageClassName":""}}` | Database configuration for Filebrowser | |
32 | | -| db.pvc | object | `{"accessModes":["ReadWriteOnce"],"enabled":true,"size":"256Mi","storageClassName":""}` | Database persistence configuration | |
| 19 | +| affinity | object | `{}` | Map of node/pod affinities | |
| 20 | +| config | object | see [values.yaml](values.yaml) | File Browser application specific configuration | |
33 | 21 | | db.pvc.accessModes | list | `["ReadWriteOnce"]` | Access modes for the database PVC | |
34 | 22 | | db.pvc.enabled | bool | `true` | Enable persistence for database | |
| 23 | +| db.pvc.existingClaim | string | `""` | Existing claim for the database | |
35 | 24 | | db.pvc.size | string | `"256Mi"` | Size for the database PVC | |
36 | 25 | | db.pvc.storageClassName | string | `""` | Storage class name for the database PVC | |
37 | | -| enabled | bool | `false` | Enable the actual filebrowser deployment. Set to true to deploy the filebrowser component | |
38 | | -| fullnameOverride | string | `"sas-retrieval-agent-manager-filebrowser"` | String to fully override the fullname template with a string | |
39 | | -| image | object | `{"pullPolicy":"IfNotPresent","repo":{"base":"docker.io","path":"filebrowser/filebrowser"},"tag":"v2.42.1"}` | Container image configuration for Filebrowser and related services | |
| 26 | +| fullnameOverride | string | `""` | String to fully override the fullname template with a string | |
40 | 27 | | image.pullPolicy | string | `"IfNotPresent"` | Container image pull policy | |
41 | | -| image.repo | object | `{"base":"docker.io","path":"filebrowser/filebrowser"}` | Container image configuration | |
42 | | -| image.repo.base | string | `"docker.io"` | Container registry base URL | |
43 | | -| image.repo.path | string | `"filebrowser/filebrowser"` | Container image path/name | |
44 | | -| image.tag | string | `"v2.42.1"` | Overrides the image tag whose default is the chart appVersion. | |
| 28 | +| image.repository | string | `"docker.io/filebrowser/filebrowser"` | Container image name | |
| 29 | +| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. | |
45 | 30 | | imagePullSecrets | list | `[]` | Array of imagePullSecrets in the namespace for pulling images | |
46 | | -| ingress | object | `{"annotations":{"nginx.ingress.kubernetes.io/auth-signin":"https://$host/SASRetrievalAgentManager/oauth2/start?rd=$escaped_request_uri","nginx.ingress.kubernetes.io/auth-url":"https://$host/SASRetrievalAgentManager/oauth2/auth","nginx.ingress.kubernetes.io/proxy-body-size":"500m","nginx.ingress.kubernetes.io/proxy-buffer-size":"16k","nginx.ingress.kubernetes.io/rewrite-target":"/$2","nginx.ingress.kubernetes.io/ssl-redirect":"true"},"className":"nginx","enabled":true,"paths":[{"path":"/SASRetrievalAgentManager/files(/|$)(.*)","pathType":"ImplementationSpecific"}],"tls":[],"useGlobal":false}` | Ingress configuration for external access to Filebrowser | |
47 | | -| ingress.annotations | object | `{"nginx.ingress.kubernetes.io/auth-signin":"https://$host/SASRetrievalAgentManager/oauth2/start?rd=$escaped_request_uri","nginx.ingress.kubernetes.io/auth-url":"https://$host/SASRetrievalAgentManager/oauth2/auth","nginx.ingress.kubernetes.io/proxy-body-size":"500m","nginx.ingress.kubernetes.io/proxy-buffer-size":"16k","nginx.ingress.kubernetes.io/rewrite-target":"/$2","nginx.ingress.kubernetes.io/ssl-redirect":"true"}` | Annotations for the Ingress | |
48 | | -| ingress.annotations."nginx.ingress.kubernetes.io/auth-signin" | string | `"https://$host/SASRetrievalAgentManager/oauth2/start?rd=$escaped_request_uri"` | OAuth2 authentication sign-in URL | |
49 | | -| ingress.annotations."nginx.ingress.kubernetes.io/auth-url" | string | `"https://$host/SASRetrievalAgentManager/oauth2/auth"` | OAuth2 authentication validation URL | |
50 | | -| ingress.annotations."nginx.ingress.kubernetes.io/proxy-body-size" | string | `"500m"` | Maximum allowed size of client request body (for file uploads) | |
51 | | -| ingress.annotations."nginx.ingress.kubernetes.io/proxy-buffer-size" | string | `"16k"` | Size of buffer used for reading the first part of response received from proxied server | |
52 | | -| ingress.annotations."nginx.ingress.kubernetes.io/rewrite-target" | string | `"/$2"` | URL rewrite rule to strip the prefix path | |
53 | | -| ingress.annotations."nginx.ingress.kubernetes.io/ssl-redirect" | string | `"true"` | Force SSL redirect | |
54 | | -| ingress.className | string | `"nginx"` | Class name of the Ingress | |
55 | | -| ingress.enabled | bool | `true` | Enable ingress for external access to API | |
56 | | -| ingress.paths | list | `[{"path":"/SASRetrievalAgentManager/files(/|$)(.*)","pathType":"ImplementationSpecific"}]` | Ingress path configuration when useGlobal is true | |
57 | | -| ingress.tls | list | `[]` | TLS configuration for ingress | |
58 | | -| ingress.useGlobal | bool | `false` | Use global ingress configuration instead of local hosts configuration | |
| 31 | +| ingress.annotations | object | `{}` | Annotations for the Ingress | |
| 32 | +| ingress.className | string | `""` | Class name of the Ingress | |
| 33 | +| ingress.enabled | bool | `false` | Enable the use of the ingress controller to access the web UI | |
| 34 | +| ingress.hosts | list | see [values.yaml](values.yaml) | Hosts for the ingress | |
| 35 | +| ingress.tls | list | `[]` | | |
59 | 36 | | initContainers | list | `[]` | Set of initContainers for the deployment | |
60 | | -| livenessProbe | object | `{}` | Liveness probe configuration (disabled by default, enable if needed) | |
61 | | -| nameOverride | string | `"filebrowser"` | String to partially override the fullname template with a string (will prepend the release name) | |
| 37 | +| livenessProbe | object | `{}` | Liveness probe configuration | |
| 38 | +| nameOverride | string | `""` | String to partially override the fullname template with a string (will prepend the release name) | |
62 | 39 | | nodeSelector | object | `{}` | Node labels for pod assignment | |
63 | | -| podAnnotations | object | `{}` | Annotations to add to the pods | |
64 | | -| podLabels | object | `{"sas.com/deployment":"sas-retrieval-agent-manager","workload.sas.com/class":"ram"}` | Labels to add to the pods | |
| 40 | +| podAnnotations | object | `{}` | Annotations of the pods | |
65 | 41 | | podSecurityContext | object | `{}` | The security context for the pods | |
66 | | -| readinessProbe | object | `{"httpGet":{"path":"/health","port":"http"}}` | Readiness probe configuration | |
| 42 | +| readinessProbe | object | see [values.yaml](values.yaml) | Readiness probe configuration | |
67 | 43 | | replicaCount | int | `1` | Number of replicas to run. Chart is not designed to scale horizontally, use at your own risk | |
68 | 44 | | resources | object | `{}` | The resources to allocate for the container | |
69 | | -| rootDir.hostPath | object | `{"path":"/mnt/data"}` | Host path configuration (only used when type is 'hostPath') | |
70 | | -| rootDir.hostPath.path | string | `"/mnt/data"` | Path on the host to mount | |
71 | | -| rootDir.pvc | object | `{"accessModes":["ReadWriteOnce"],"createStorageClass":true,"name":"vhub-pv","size":"20Gi","storageClassName":"azurefile-sas"}` | Persistent Volume Claim configuration (only used when type is 'pvc') | |
| 45 | +| rootDir.hostPath.path | string | `"/path/on/host"` | | |
72 | 46 | | rootDir.pvc.accessModes | list | `["ReadWriteOnce"]` | Access modes for the root directory PVC | |
73 | | -| rootDir.pvc.createStorageClass | bool | `true` | Whether to create the storage class if it doesn't exist | |
74 | | -| rootDir.pvc.name | string | `"vhub-pv"` | Name for the PVC | |
75 | | -| rootDir.pvc.size | string | `"20Gi"` | Size for the root directory PVC | |
76 | | -| rootDir.pvc.storageClassName | string | `"azurefile-sas"` | Storage class name for the root directory PVC | |
| 47 | +| rootDir.pvc.existingClaim | string | `""` | Existing claim for the root directory | |
| 48 | +| rootDir.pvc.size | string | `"2Gi"` | Size for the root directory PVC | |
| 49 | +| rootDir.pvc.storageClassName | string | `""` | Storage class name for the root directory PVC | |
77 | 50 | | rootDir.readOnly | bool | `false` | Mount the root directory in read-only mode | |
78 | | -| rootDir.type | string | `"pvc"` | Type of rootDir mount. Valid values are [pvc, hostPath, emptyDir] | |
| 51 | +| rootDir.type | string | `"pvc"` | type of rootDir mount. Valid values are [pvc, hostPath, emptyDir] | |
79 | 52 | | securityContext | object | `{}` | The security context for the application container | |
80 | | -| service | object | `{"port":80,"type":"ClusterIP"}` | Kubernetes Service configuration | |
81 | 53 | | service.port | int | `80` | Kubernetes Service port | |
82 | 54 | | service.type | string | `"ClusterIP"` | Kubernetes Service type | |
83 | | -| serviceAccount | object | `{"annotations":{},"create":true,"name":""}` | Service account configuration for API | |
84 | 55 | | serviceAccount.annotations | object | `{}` | Annotations to add to the service account | |
85 | 56 | | serviceAccount.create | bool | `true` | Specifies whether a service account should be created | |
86 | 57 | | serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | |
87 | | -| strategy | object | `{"type":"Recreate"}` | Deployment strategy to use (Recreate is recommended for stateful applications) | |
88 | | -| tolerations | list | `[]` | Tolerations for pod assignment | |
89 | | - |
90 | | ----------------------------------------------- |
91 | | -Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) |
| 58 | +| strategy | object | `{"type":"Recreate"}` | Deployment strategy to use | |
| 59 | +| tolerations | list | `[]` | Tolerations for pod assignment | |
0 commit comments