Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaaaco/webdav-uid-gid
WebDAV server with Nginx that runs with a specified UID and GID ready to use in kubernetes environment
https://github.com/jaaaco/webdav-uid-gid
k8s kubernetes volumes webdav
Last synced: 29 days ago
JSON representation
WebDAV server with Nginx that runs with a specified UID and GID ready to use in kubernetes environment
- Host: GitHub
- URL: https://github.com/jaaaco/webdav-uid-gid
- Owner: jaaaco
- Created: 2024-07-28T09:52:17.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-28T13:23:08.000Z (6 months ago)
- Last Synced: 2024-10-31T11:05:17.375Z (3 months ago)
- Topics: k8s, kubernetes, volumes, webdav
- Language: Shell
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This Docker image sets up a WebDAV server with Nginx that runs with a specified UID and GID, ensuring that any files created by the server retain the correct ownership.
## Features
- WebDAV server based on Nginx
- Basic authentication support
- Customizable UID and GID for proper file ownership
- Configurable through environment variables
## Usage
To run the WebDAV server with the custom UID and GID, use the following Docker commands.
### Running with Docker
```sh
docker run -d \
--name webdav \
-e USERNAME= \
-e PASSWORD= \
-e UID= \
-e GID= \
-e TZ= \
-v /path/to/your/data:/data \
-p 80:80 \
jaaaco/webdav-uid-gid:latest
```
### Environment Variables
- `USERNAME`: The username for basic authentication (default: `your-username`)
- `PASSWORD`: The password for basic authentication (default: `your-password`)
- `UID`: The user ID to run the server as (default: `your-uid`)
- `GID`: The group ID to run the server as (default: `your-gid`)
- `TZ`: The timezone for the server (default: `your-timezone`)
### Volumes
- `/data`: Mount your data directory to this path to expose it via WebDAV.
### Ports
- `80`: The default port where the WebDAV server will be accessible.
## Kubernetes Deployment
The Docker image can also be used in a Kubernetes deployment. Below is a sample Kubernetes configuration:
### Sample Kubernetes Configuration
```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: webdav
namespace:
spec:
strategy:
type: Recreate
selector:
matchLabels:
app: webdav
template:
metadata:
labels:
app: webdav
spec:
serviceAccountName:
volumes:
- name:
persistentVolumeClaim:
claimName:
containers:
- image: jaaaco/webdav-uid-gid:latest
name: webdav
volumeMounts:
- name:
mountPath: /data
env:
- name: TZ
value:
- name: USERNAME
value:
- name: PASSWORD
value:
- name: UID
value: ""
- name: GID
value: ""
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: webdav-ingress
namespace:
annotations:
nginx.ingress.kubernetes.io/proxy-body-size: 512m
spec:
ingressClassName: nginx
rules:
- host:
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: webdav
port:
name: webdav
---
apiVersion: v1
kind: Service
metadata:
name: webdav
namespace:
spec:
ports:
- port: 80
protocol: TCP
targetPort: 80
name: webdav
selector:
app: webdav
```
### Deploying to Kubernetes
1. **Modify the Deployment Configuration:**
Update the Kubernetes YAML configuration files with your specific values:
- Replace `` with your namespace.
- Replace `` with your service account name.
- Replace `` with your volume name.
- Replace `` with your PersistentVolumeClaim name.
- Replace `` with your desired timezone.
- Replace ``, ``, ``, and `` with your specific values.
- Replace `` with your desired host.
2. **Apply the Deployment:**
Apply the deployment configuration to your Kubernetes cluster:
```sh
kubectl apply -f path/to/your/deployment.yml
```
## License
This project is licensed under the MIT License.
## Contributing
Contributions are welcome! Please submit a pull request or open an issue to discuss any changes or improvements.