README
¶
AltMount
A WebDAV server backed by NZB/Usenet that provides seamless access to Usenet content through standard WebDAV protocols.
📖 Documentation
Complete setup guides, configuration options, API reference, and troubleshooting information.
Quick Start
Docker (Recommended)
services:
altmount:
extra_hosts:
- "host.docker.internal:host-gateway" # Optional if you rclone is outside the container
image: ghcr.io/javi11/altmount:latest
container_name: altmount
environment:
- PUID=1000
- PGID=1000
- PORT=8080
- JWT_SECRET=change-me-to-a-strong-random-secret # Required when login is enabled (auth.login_required: true)
- COOKIE_DOMAIN=localhost # Must match the domain/IP where web interface is accessed
volumes:
- ./config:/config
- /mnt:/mnt:rshared
- /metadata:/metadata # This is optional you can still use /mnt
ports:
- "8080:8080"
restart: unless-stopped
devices:
- /dev/fuse:/dev/fuse:rwm
cap_add:
- SYS_ADMIN
security_opt:
- apparmor:unconfined
CLI Installation
go install github.com/javi11/altmount@latest
altmount serve --config config.yaml
Links
- 📚 Documentation
- 🐛 Issues
- 💬 Discussions
Contributing
See the Development Guide. Development/setup for information on setting up a development environment and contributing to the project.
License
This project is licensed under the terms specified in the LICENSE file.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
altmount
command
|
|
|
internal
|
|
|
encryption/rclone/pkcs7
Package pkcs7 implements PKCS#7 padding
|
Package pkcs7 implements PKCS#7 padding |
|
errors
Package errors provides shared error types used across multiple packages.
|
Package errors provides shared error types used across multiple packages. |
|
httpclient
Package httpclient provides a centralized HTTP client factory with preset configurations.
|
Package httpclient provides a centralized HTTP client factory with preset configurations. |
|
importer
Package importer provides import queue processing for NZB files.
|
Package importer provides import queue processing for NZB files. |
|
importer/postprocessor
Package postprocessor handles all post-import processing steps including symlink creation, STRM file generation, VFS notifications, health check scheduling, and ARR notifications.
|
Package postprocessor handles all post-import processing steps including symlink creation, STRM file generation, VFS notifications, health check scheduling, and ARR notifications. |
|
importer/queue
Package queue provides queue management for the NZB import service.
|
Package queue provides queue management for the NZB import service. |
|
importer/scanner
Package scanner provides directory scanning and NZBDav import functionality.
|
Package scanner provides directory scanning and NZBDav import functionality. |
|
nzbfilesystem/segcache
Package segcache provides a segment-aligned disk cache for Usenet file data.
|
Package segcache provides a segment-aligned disk cache for Usenet file data. |
|
pathutil
Package pathutil provides path validation utilities.
|
Package pathutil provides path validation utilities. |
|
pkg
|
|
Click to show internal directories.
Click to hide internal directories.