docs: Add 1 and update 13 files
All checks were successful
Test and Publish Templates / test-and-publish (push) Successful in 49s
All checks were successful
Test and Publish Templates / test-and-publish (push) Successful in 49s
This commit is contained in:
@@ -2,11 +2,18 @@ Wiki.js Dropshell Template
|
||||
==========================
|
||||
|
||||
A modern, lightweight and powerful wiki application built on Node.js.
|
||||
Uses the LinuxServer.io container image for easy deployment.
|
||||
Uses Docker Compose with PostgreSQL database for reliability.
|
||||
|
||||
Source: https://hub.docker.com/r/linuxserver/wikijs
|
||||
Docs: https://docs.linuxserver.io/images/docker-wikijs
|
||||
|
||||
Architecture
|
||||
------------
|
||||
|
||||
This template runs two containers:
|
||||
- wikijs: The Wiki.js application (linuxserver/wikijs)
|
||||
- wikijs_db: PostgreSQL 15 database
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
@@ -19,7 +26,9 @@ HTTP_PORT - Web interface port (default: 3080)
|
||||
PUID - User ID for file permissions (default: 1000)
|
||||
PGID - Group ID for file permissions (default: 1000)
|
||||
TZ - Timezone (default: Pacific/Auckland)
|
||||
DB_TYPE - Database type: sqlite or postgres (default: sqlite)
|
||||
DB_NAME - PostgreSQL database name (default: wikijs)
|
||||
DB_USER - PostgreSQL username (default: wikijs)
|
||||
DB_PASS - PostgreSQL password (default: changeme) ** CHANGE THIS! **
|
||||
|
||||
Ports
|
||||
-----
|
||||
@@ -30,8 +39,9 @@ Data Storage
|
||||
------------
|
||||
|
||||
All persistent data is stored in DATA_PATH:
|
||||
- config/ - Wiki.js configuration files
|
||||
- data/ - Wiki content and database
|
||||
- config/ - Wiki.js configuration files
|
||||
- data/ - Wiki.js data and uploads
|
||||
- postgres/ - PostgreSQL database files
|
||||
|
||||
First Run
|
||||
---------
|
||||
@@ -45,30 +55,24 @@ You will be guided through the initial setup wizard to:
|
||||
Database
|
||||
--------
|
||||
|
||||
By default, Wiki.js uses SQLite (DB_TYPE=sqlite) which requires no
|
||||
additional setup and stores data in DATA_PATH/data/.
|
||||
PostgreSQL 15 is included and configured automatically.
|
||||
Database credentials are set in service.env.
|
||||
|
||||
For PostgreSQL support, set DB_TYPE=postgres and configure these
|
||||
additional environment variables in service.env:
|
||||
DB_HOST - PostgreSQL server hostname
|
||||
DB_PORT - PostgreSQL server port (default: 5432)
|
||||
DB_NAME - Database name
|
||||
DB_USER - Database username
|
||||
DB_PASS - Database password
|
||||
|
||||
Note: Database settings only apply on first run. After initial setup,
|
||||
modify DATA_PATH/config/config.yml directly.
|
||||
IMPORTANT: Change DB_PASS from the default before first install!
|
||||
|
||||
Backup & Restore
|
||||
----------------
|
||||
|
||||
Use the backup.sh and restore.sh scripts to backup and restore
|
||||
your wiki data. Backups include all configuration and content.
|
||||
your wiki data. Backups include:
|
||||
- Wiki.js configuration
|
||||
- PostgreSQL database
|
||||
- Uploaded assets
|
||||
|
||||
Notes
|
||||
-----
|
||||
|
||||
- The container runs as non-root using PUID/PGID
|
||||
- Configuration changes after first run should be made through
|
||||
the Wiki.js admin panel or by editing config/config.yml
|
||||
- Both containers restart automatically unless stopped
|
||||
- The database container must be running for Wiki.js to work
|
||||
- SSL/TLS should be handled by a reverse proxy (e.g., Caddy)
|
||||
- Use 'docker compose logs' to view logs from both containers
|
||||
|
||||
Reference in New Issue
Block a user