dropshell-templates

Wiki.js Dropshell Template
==========================

A modern, lightweight and powerful wiki application built on Node.js.
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
-------------

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_NAME         - PostgreSQL database name (default: wikijs)
DB_USER         - PostgreSQL username (default: wikijs)
DB_PASS         - PostgreSQL password (default: changeme) ** CHANGE THIS! **

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.js data and uploads
  - postgres/ - PostgreSQL database files

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
--------

PostgreSQL 15 is included and configured automatically.
Database credentials are set in service.env.

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:
  - Wiki.js configuration
  - PostgreSQL database
  - Uploaded assets

Notes
-----

- 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