All apps · 0 apps
NNTmux
Docker app from RapidMark's Repository
Overview
Readme
View on GitHubNNTmux for Unraid
Single-container build of NNTmux. The upstream app image is built as-is, then MariaDB, Redis and Manticore are added and everything runs under s6-overlay.
| service | what |
|---|---|
| mariadb | MariaDB 11.4, bound to 127.0.0.1 |
| redis | cache, sessions, Horizon queues |
| manticore | search engine |
| web | FrankenPHP on port 80 |
| horizon | queue workers |
| scheduler | artisan schedule:work |
| indexer | tmux processing engine, START_INDEXER=false to skip it |
Volumes
/configholds.env, MariaDB, Redis, Manticore, Laravel storage and the install lock./dataholdsnzb/andcovers/, the parts that grow.
First run
The container refuses to start without ADMIN_USER, ADMIN_EMAIL, ADMIN_PASS (12+ chars), NNTP_SERVER, NNTP_USERNAME and NNTP_PASSWORD.
It then writes /config/.env with an APP_KEY and a random DB password, creates the database and admin user, builds the Manticore tables and drops /config/install/install.lock.
Expect a few minutes.
Container environment variables always win over /config/.env, so the Unraid template drives the common settings and .env holds the rest.
Edit .env for API keys or anything the template does not expose, then restart.
Unraid
Add a container with template URL https://raw.githubusercontent.com/RapidMark/NNTmux/master/unraid/nntmux.xml, or copy nntmux.xml to /boot/config/plugins/dockerMan/templates-user/.
The template passes --stop-timeout 120 so MariaDB gets a clean shutdown.
Building
cd unraid
make build # nntmux-app:build from ../Dockerfile, then rapidmark/nntmux:dev
make lint
CI builds weekly and on pushes touching unraid/, then pushes rapidmark/nntmux:latest, :bookworm_<date> and :sha-<short>.
Needs the DOCKERHUB_USERNAME and DOCKERHUB_TOKEN repo secrets.
Updating upstream
git fetch upstream
git merge upstream/master
git push
The image is whatever commit master is at, so the merge is the pin.
Install NNTmux on Unraid in a few clicks.
Find NNTmux in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.
Requirements
Categories
Download Statistics
Related apps
Explore more like this
Explore allDetails
rapidmark/nntmux:latestRuntime arguments
- Web UI
http://[IP]:[PORT:80]/- Network
bridge- Shell
bash- Privileged
- false
- Extra Params
--stop-timeout 120
Template configuration
Web interface port
- Target
- 80
- Default
- 8085
- Value
- 8085
Settings, database, Redis and Manticore data
- Target
- /config
- Default
- /mnt/user/appdata/nntmux
- Value
- /mnt/user/appdata/nntmux
NZB files and cover images. Grows large, put it on the array if you like.
- Target
- /data
- Default
- /mnt/user/appdata/nntmux/data
- Value
- /mnt/user/appdata/nntmux/data
User id the services run as
- Default
- 99
- Value
- 99
Group id the services run as
- Default
- 100
- Value
- 100
Timezone, for example America/Chicago
- Default
- Etc/UTC
- Value
- Etc/UTC
URL you will use to reach the site, including port
- Target
- APP_URL
- Default
- http://localhost:8085
- Value
- http://localhost:8085
Usenet provider hostname
- Target
- NNTP_SERVER
563 for SSL, 119 for plain
- Target
- NNTP_PORT
- Default
- 563
- Value
- 563
true or false
- Target
- NNTP_SSLENABLED
- Default
- true
- Value
- true
- Target
- NNTP_USERNAME
- Target
- NNTP_PASSWORD
Connections your provider allows
- Target
- NNTP_CONNECTIONS
- Default
- 10
- Value
- 10
Created on first run
- Target
- ADMIN_USER
- Default
- admin
- Value
- admin
At least 12 characters. Used on first run only.
- Target
- ADMIN_PASS
Created on first run
- Target
- ADMIN_EMAIL
Set false to run only the web UI without the tmux indexing engine
- Target
- START_INDEXER
- Default
- true
- Value
- true
InnoDB buffer pool size, raise on a box with spare RAM
- Target
- DB_INNODB_BUFFER_POOL_SIZE
- Default
- 1G
- Value
- 1G
- Target
- TMDB_APIKEY
- Target
- TVDB_APIKEY
- Target
- OMDB_APIKEY
- Target
- FANARTTV_APIKEY
- Target
- TRAKTTV_APIKEY