LiveGobe Wiki

{{Disclamer|text=Current wiki implementation only works within the whole application and can't be run separately!}}

'''Welcome to the installation guide for the LiveGobe Wiki System'''
This page explains how to install, configure, and launch your own LG Website instance — whether locally or on a production server.

== Requirements ==

Before installing, ensure your system meets the following requirements:

```
Node.js: v18 or newer
MongoDB: v6.0 or newer
Git: For cloning the repository
npm: For dependency management
pm2: For production managing
```

Recommended OS: '''Ubuntu 22.04+''' or '''Windows 10+''' ('''Windows Server 2019''' is recommended).

=== Step 1 — Clone the Repository ===

Use Git to clone the official LiveGobe Website repository:

`git clone https://github.com/LiveGobe/livegobe-website.git cd livegobe-website`

== Step 2 — Install Dependencies ==

Run the following command:

<code> npm install </code>

== Step 3 — Configure Environment ==

Make a copy of the file called `config-example.js` and name it `config.js`.
Replace all values as neccessary.

== Step 4 — Run the Wiki Server ==

For development:
<code> npm test </code>
Then open in browser: [http://localhost:8080]

For production use `PM2` to run it in cluster mode in '''production''' environment.

== See also ==
* [[LGML|Module System]]
* [[Database Schema]]
* [[API|API v2 Reference]]
* [[Community#Contributing|Contributing]]
* [[Community#Report_a_Bug|Report a Bug]]
* [[Community#Feature_Requests|Feature Requests]]

[[Category:Docs]]
[[Category:Guides]]