WARNING This site is for the unreleased, still under development 3.0 version of Wiki.js. Go to the current 2.5 version instead.

Site Management

From the Administration Area, click on the Sites section from the sidebar navigation.

Multiple wiki sites can be hosted on the same Wiki.js instance. This allows you to clearly separate content belonging to different teams or products.

The following resources are tied to a site:

  • Pages (including history)
  • Comments
  • Media Assets
  • Site Configuration (e.g. theme, locales, navigation, etc.)
User Scope
Users reside at the global level and are NOT tied to a site. They can be allowed access to multiple sites at once. Use Group Rules to restrict a user access to one or more sites.

Requirements

  • Each site requires a dedicated hostname (sub-domain or domain).
  • The server cannot listen on multiple network interfaces for different sites. If you have such need, you must either use a reverse proxy (e.g. nginx) to handle traffic from different IPs or launch dedicated instances for each interface.

Create a Site

Click on the New Site button. A dialog to create a new site will appear.

New Site Dialog

PropertyDescription
NameEnter a name for your site. It will be shown in the top-left corner of the site.
HostnameEnter either a fully-qualified domain name (e.g. wiki.example.com) or * (wildcard) for a catch-all site. Note that there can only be 1 catch-all site. This is used to route requests to the proper site. If a request doesn't match any hostname, it will fallback to the catch-all site.

Both values can be changed at any time later from the General page.

Modify a Site

From the left sidebar, select the site you want to edit from the dropdown menu:

Site Selector

Sidebar menu items (e.g. General, Analytics, etc.) under the Site section will affect only the currently selected site.

The General page is where most of the site settings can be customized.

Site Info

PropertyDescription
Site TitleThe name of the site displayed in the header and appended to the pages meta title.
Site DescriptionThe default description when none is provided for a page.
Site HostnameThe hostname the site will respond to. Can be set to * (wildcard) for catch-all site. Note that there can only be 1 catch-all site. This is used to route requests to the proper site. If a request doesn't match any hostname, it will fallback to the catch-all site.
PropertyDescription
Company / Organization NameName to use when displaying the copyright notice in the footer. Leave empty to hide. A content license must also be selected for it to appear.
Content LicenseLicense shown in the footer of all content pages.
Additional Footer TextOptionally add more content to the footer, such as additional copyright terms or mandatory regulatory info. Shown below the copyright line.

Features

Site-wide Settings
The options below are site-wide switches that will override any setting set by page rules.
PropertyDescription
Allow CommentsCan users leave comments on pages? Can be restricted using Page Rules.
Allow ContributionsCan users with read access permissions propose changes for pages? Can be restricted using Page Rules.
Allow Profile EditingCan users edit their own profile? If profile data is managed by an external identity provider, you should turn this off.
Allow RatingsCan users leave ratings on pages? Can be restricted using Page Rules.
Allow SearchCan users search for content they have read access to? The search bar will be hidden if turned off.

URL Handling

PropertyDescription
Page ExtensionsA comma-separated list of URL extensions that will be treated as pages. For example, adding md will treat /foobar.md the same as /foobar.
Assets Conflict
Any extensions listed above will take result in the requested resource be treated as a page, even if an asset with the same name and extensions exists.
Extension Required
Note that all upload options below require the Sharp extension to be enabled on your instance.
PropertyDescription
Site LogoLogo image file, in SVG, PNG, JPG, WEBP or GIF format. Should be a square image, otherwise turn off the Display Site Title option.
Display Site TitleShould the site title be displayed next to the logo? If your logo isn't square and contain your brand name, turn this option off.
FaviconFavicon image file, in SVG, PNG, JPG, WEBP or GIF format. Must be a square image. Shown in browser tabs and as the app icon on mobile.

Site Defaults

PropertyDescription
Default Timezone The default timezone for new users.
Default Date Format The default date format for new users.
Default Time Format The default time format for new users.
Default ToC Depth The default minimum and maximum header levels to show in the table of contents.

SEO

PropertyDescription
Allow Indexing by Search EnginesThis sets the meta-robots property to index or noindex.
Allow Search Engines to Follow LinksThis sets the meta-robots property to follow or nofollow.
Allow SitemapMake a sitemap.xml available to search engines with all pages accessible to guests.

Disable a Site

You can disable a site which prevents all non-administrator users from accessing it. This is useful if you need to perform maintenance operations and want to prevent any changes to the site during this timeframe.

From the Sites section, click on the Active toggle next to the site you want to disable. You'll be prompted to confirm your choice.

To re-enable a site, click on the same toggle again.

Delete a Site

To delete a site, click the red delete button next to the desired site. You'll be prompted to confirm your choice.

CAUTION
This will permanently delete all pages, comments, assets and settings associated to this site! Note that users will NOT be affected as they are global to the instance and not tied to a specific site.