Wiki.js is a feature-rich, open-source wiki application designed on the Node.js framework. It offers a versatile editing experience with support for both Markdown and WYSIWYG interfaces. In addition, it facilitates real-time collaboration, version control, and a variety of authentication methods, including Google and LDAP integrations. This comprehensive guide will walk you through the necessary steps to set up Wiki.js using Docker, enabling you to deploy your own wiki in just a matter of minutes.
Setting Up Wiki.js via Docker Compose
The setup process for Wiki.js using Docker and Docker Compose is straightforward. Begin by creating a new directory called wikijs-docker and navigate into it:
mkdir wikijs-docker && cd wikijs-docker
Next, create a file named docker-compose.yml using your preferred text editor:
nano docker-compose.yml
Then, insert the following configuration into the file:
services: db: image: postgres:16 environment: POSTGRES_DB: wiki POSTGRES_PASSWORD: wikijsrocks POSTGRES_USER: wikijs restart: unless-stopped volumes: - db-data:/var/lib/postgresql/data wiki: image: ghcr.io/requarks/wiki:2 depends_on: - db environment: DB_TYPE: postgres DB_HOST: db DB_PORT: 5432 DB_USER: wikijs DB_PASS: wikijsrocks DB_NAME: wiki restart: unless-stopped ports: - "80:3000" volumes: db-data:
After saving and closing the file, initiate the containers by executing the following command:
docker compose up -d
Once the setup process is completed, navigate to http://localhost in your web browser. Here, you’ll need to provide the administrator account details and select the Install button to commence the installation:
Upon completing the installation, log in using your credentials.
Creating and Managing Pages in Wiki.js
With the initial setup complete, you can establish your home page to begin populating your content or access the administration panel for managing your settings, users, and available features:
By clicking the Create Home Page option, you will be prompted to choose an editor tailored to your preferences:
Next, define the properties of your page and hit the OK button to proceed with creating a new page:
Write your desired content and click the Create button to finalize the page creation:
Managing and Organizing Content
Your dashboard provides a convenient way to view and modify existing pages, as well as create new ones using your chosen editor. You can organize your content by renaming, moving, or deleting pages, and utilize tags for effective categorization. Additionally, the sidebar and search functionality expedite navigation to specific pages within your wiki:
Configuring Wiki.js Site Settings
Within the Wiki.js administration panel, you have the flexibility to configure site settings such as locale, navigation structures, themes, and tags. These settings play a crucial role in defining the overall configuration of your Wiki.js instance.
Under the General tab, you can adjust fundamental site settings, including the site title, description, default homepage, and visibility settings (public or private):
Switch to the Locale tab to specify the default language, timezone, and date/time formats for your site:
To manage your wiki’s menu structure and enhance user navigation, visit the Navigation bar section:
In the Pages tab, you can oversee, edit, and organize all wiki pages, create new pages, and manage the hierarchy of your content:
Furthermore, under the Tags tab, you can create and manage content tags, enhancing page searchability. You can also customize the aesthetic elements of your wiki via the Theme tab, where you can alter the site logo, colors, fonts, and layout styles.
Managing Groups in Your Wiki
The Groups section allows you to create user groups, designate members, and establish group-level permissions to regulate access. This organizational method helps streamline user roles and maintains consistent access management throughout your wiki.
Clicking on a specific group provides access to update its settings, permissions, page rules, and user management within that group. Through the Settings tab, you can adjust options, including the login redirect URL.
You can also navigate through the sections for Permissions, Page Rules, and Users to refine what the group can access and assign users accordingly.
User Management in Wiki.js
To add a new user, head to the Users section, click the NEW USER button, and fill in the required fields.
Once completed, select CREATE or CREATE AND CLOSE to finalize the new user setup:
Selecting a particular user allows you to view and edit their profile, assign user groups, define authentication methods (like passwords or two-factor authentication), and manage their status with actions like Deactivate, Verify, or Delete:
Additionally, you can update their basic information, extended metadata (including location and job title), and view their activity history:
Managing Your Wiki Modules
Modules are enhancements that augment the capabilities of Wiki.js. For instance, the Analytics module allows you to integrate tools like Google Analytics to track user engagement and traffic metrics:
Utilize the Authentication tab to establish and manage authentication providers (local login, LDAP, OAuth) alongside configuring various login options:
You can also toggle the commenting system on or off and determine how users engage in page discussions:
System Configuration
Manage how content is rendered, indexed for search, and stored by configuring rendering engines, search indexing, and storage settings. For instance, access the Rendering tab to tailor content rendering, such as adjusting Markdown engine settings or enabling support for diagrams and mathematical expressions:
In the Search Engine section, you can manage internal search indexing options and third-party search engine integrations:
In the Storage section, specify backup and synchronization targets for your content, enabling you to manage where and how media and page attachments are stored (such as on the local filesystem or AWS S3):
Managing Security and Connectivity
You can secure your Wiki.js instance by configuring API access, setting email notifications, adjusting security policies, and enabling SSL for a secure experience. For example, handle API tokens to integrate Wiki.js with other applications:
Set up email configurations for managing notifications, invitations, and password recovery processes within Wiki.js:
Security settings can also be fine-tuned, covering aspects like session timeouts, password policies, and access restrictions:
Moreover, you can set up SSL/TLS certificates to ensure your Wiki.js instance operates securely over HTTPS:
Additionally, verify your Wiki information such as system diagnostics, server specifications, and runtime environment stats from the System Info section:
Perform maintenance activities like re-indexing search results, clearing cached data, or resetting configurations from the Utilities tab:
Lastly, the Developer Tools offer advanced resources such as GraphQL playground, log debugging capabilities, or custom script integrations:
Now that you are equipped with the knowledge to set up Wiki.js using Docker, you can confidently use this platform to create internal documentation, collaborative team wikis, or public knowledge bases effortlessly.
Leave a Reply ▼