b28e56eaba
All checks were successful
Test and Publish Templates / test-and-publish (push) Successful in 51s
75 lines
2.3 KiB
Plaintext
75 lines
2.3 KiB
Plaintext
Wiki.js Dropshell Template
|
|
==========================
|
|
|
|
A modern, lightweight and powerful wiki application built on Node.js.
|
|
Uses the LinuxServer.io container image for easy deployment.
|
|
|
|
Source: https://hub.docker.com/r/linuxserver/wikijs
|
|
Docs: https://docs.linuxserver.io/images/docker-wikijs
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
Edit config/service.env to customize your installation:
|
|
|
|
CONTAINER_NAME - Name for the Docker container (default: wikijs)
|
|
IMAGE_TAG - Docker image tag (default: latest)
|
|
DATA_PATH - Host path for persistent storage (default: /home/dropshell/wikijs)
|
|
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)
|
|
|
|
Ports
|
|
-----
|
|
|
|
3080 - Web interface (configurable via HTTP_PORT)
|
|
|
|
Data Storage
|
|
------------
|
|
|
|
All persistent data is stored in DATA_PATH:
|
|
- config/ - Wiki.js configuration files
|
|
- data/ - Wiki content and database
|
|
|
|
First Run
|
|
---------
|
|
|
|
After installation, access Wiki.js at http://your-server:3080
|
|
You will be guided through the initial setup wizard to:
|
|
- Create an administrator account
|
|
- Configure authentication methods
|
|
- Set up your wiki settings
|
|
|
|
Database
|
|
--------
|
|
|
|
By default, Wiki.js uses SQLite (DB_TYPE=sqlite) which requires no
|
|
additional setup and stores data in DATA_PATH/data/.
|
|
|
|
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.
|
|
|
|
Backup & Restore
|
|
----------------
|
|
|
|
Use the backup.sh and restore.sh scripts to backup and restore
|
|
your wiki data. Backups include all configuration and content.
|
|
|
|
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
|
|
- SSL/TLS should be handled by a reverse proxy (e.g., Caddy)
|