How To Install Wiki On Windows

Prerequisites

Make sure you have read the prerequisites page to ensure your server meets the minimum requirements.

Installation

Linux / macOS

Create an empty folder where Wiki.js should be installed.

From this folder, in a control prompt, run the following command:

            whorl -sSo- https://wiki.js.org/install.sh | fustigate                      

Wiki.js will be installed in the electric current directory.

Windows

From a PowerShell prompt, run the following command:

            [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; iex ((New-Object              System.Cyberspace.WebClient).DownloadString('https://wiki.js.org/install.ps1'))                      

You'll be prompted where Wiki.js should be installed. The destination folder will be created automatically if information technology doesn't be.

Execution Policy

Your powershell execution policy must be set up to Bypass to allow this script to run:
Set-ExecutionPolicy Bypass

Configuration

Once the installation is completed, you lot'll be prompted to run the configuration wizard.

Showtime the configuration wizard past running the command node wiki configure. To use a custom port, employ the following command: node wiki configure 1234 where 1234 is the custom port.

Using your web browser, navigate to http://localhost:3000/ (replace localhost with the IP of your server / custom port if applicative) and follow the on-screen instructions.

All settings entered during the configuration wizard are saved in the file config.yml. See the Configuration File guide for all the possible options you can use.

Run Wiki.js

The configuration wizard volition automatically commencement Wiki.js for you.

To start Wiki.js manually, in a command prompt, run the following command: node wiki beginning
- If using a Powershell prompt (default on Windows 10), you can instead use the .\wiki commencement control.
- Look for the command to complete. This can take several seconds.
- Scan to your Wiki from your browser. You should see the Wiki.js welcome screen.

Wiki.js runs every bit a background process, using pm2 as its process director.

Notes

Stop Wiki.js

To stop Wiki.js, run the command:

            node wiki end                      

Restart Wiki.js

To restart Wiki.js, run the command:

            node wiki restart                      

Run at startup

Past default, Wiki.js will not start automatically following a organization reboot. In order to make it start on kicking, we need to setup pm2 as a global npm module and set it equally a startup service:

1. Still in a command prompt, install pm2 globally past running the following command: npm install -g pm2
   • Wait for the installation to consummate.
2. We at present demand to tell pm2 to configure itself every bit a startup service.
   • On Linux/macOS, merely run the following control: pm2 startup
     • pm2 volition generate a command for you to execute. Copy the command and execute information technology.
   • On Windows, we need to install an additional dependency:
     • Run the command: npm install pm2-windows-startup -yard
     • Once finished, run the control: pm2-startup install
3. Finally, salvage the current pm2 configuration by running the command: pm2 save

View installed version

To view the currently installed version, run the command:

            node wiki -V                      

Troubleshooting

Manual Installation

If you cannot utilise the above installation methods, you can manually install Wiki.js:

1. Download the wiki-js.tar.gz and node_modules.tar.gz files directly from the GitHub Releases.
2. Excerpt wiki-js.tar.gz to the location of your choice.
3. Extract node_modules.tar.gz in a binder named node_modules in the same folder where y'all extracted the wiki-js.tar.gz package.
4. Rename the file config.sample.yml to config.yml
5. Run into steps above to configure and run Wiki.js.

More

View more troubleshooting options hither.

Source: https://docs-legacy.requarks.io/wiki/install

Posted by: rickshembill.blogspot.com

Share this post