wikijs-fork/npm/README.md

27 lines
1.4 KiB
Markdown
Raw Normal View History

2017-04-29 05:15:25 +00:00
![Wiki.js](https://raw.githubusercontent.com/Requarks/wiki-site/1.0/assets/images/logo.png)
2017-02-15 01:48:39 +00:00
# Wiki.js
[![npm](https://img.shields.io/npm/v/wiki.js.svg?style=flat-square)](https://github.com/Requarks)
[![Release](https://img.shields.io/github/release/Requarks/wiki.svg?style=flat-square&maxAge=3600)](https://github.com/Requarks/wiki/releases)
[![License](https://img.shields.io/badge/license-AGPLv3-blue.svg?style=flat-square)](https://github.com/requarks/wiki/blob/master/LICENSE)
2017-04-29 05:15:25 +00:00
This npm package is an installer for Wiki.js.
For information about Wiki.js, including detailed installation steps, read the following links:
2017-02-15 01:48:39 +00:00
2017-04-29 05:15:25 +00:00
- [Official Website](https://wiki.js.org/)
- [Installation Guide](https://wiki.js.org/get-started.html)
2017-02-15 01:48:39 +00:00
- [GitHub Repository](https://github.com/Requarks/wiki)
2017-04-07 03:01:00 +00:00
### Install Wiki.js
2017-02-15 01:48:39 +00:00
2017-04-29 05:15:25 +00:00
1. Make sure you meet all [prerequisites](https://docs.requarks.io/wiki/prerequisites).
2. Create an empty folder where Wiki.js will run.
3. Launch a terminal / command prompt inside this newly created folder.
4. Run the command: `npm install wiki.js@latest`
5. Wait for the installation process to complete. This may take several minutes.
6. You'll be prompted to run the configuration wizard to finish the installation.
2017-02-15 01:48:39 +00:00
2017-04-07 03:01:00 +00:00
The configuration wizard can also be run manually using: `node wiki configure [port]`
To start Wiki.js manually, run the command: `node wiki start`