docs: update README

pull/6078/head
Nicolas Giard 2 years ago
parent 67d8234dfd
commit 85a74aa323
No known key found for this signature in database
GPG Key ID: 85061B8F9D55B7C8

@ -81,11 +81,12 @@ The current stable release (2.x) is available at https://js.wiki
### Usage ### Usage
1. Clone the project 1. Clone the project.
1. Open the project in VS Code 1. Open the project in VS Code.
1. Make sure you have **Dev Containers** extension installed. (On Windows, you need the **WSL** VS Code extension as well.) 1. Make sure you have **Dev Containers** extension installed. (On Windows, you need the **WSL** VS Code extension as well.)
1. Reopen the project in container (from the popup in the lower-right corner of the screen when opening the project, or via the Command Palette (Ctrl+Shift+P) afterwards). 1. Reopen the project in container (from the popup in the lower-right corner of the screen when opening the project, or via the Command Palette (Ctrl+Shift+P) afterwards).
1. Once in container mode, run the task "Create terminals" from the Command Palette: 1. Once in container mode, make a copy of `config.sample.yml` and rename it to `config.yml`. There's no need to edit the file, the default values are ok.
1. From the Command Palette, run the task "Create terminals":
- Launch the Command Palette (Ctrl+Shift+P) - Launch the Command Palette (Ctrl+Shift+P)
- Type "Run Task" and press Enter - Type "Run Task" and press Enter
- Select the task "Create terminals" and press Enter - Select the task "Create terminals" and press Enter

@ -2,7 +2,7 @@
# Wiki.js - CONFIGURATION # # Wiki.js - CONFIGURATION #
####################################################################### #######################################################################
# Full documentation + examples: # Full documentation + examples:
# https://docs.js.wiki/install # https://js.wiki/docs/install
# --------------------------------------------------------------------- # ---------------------------------------------------------------------
# Port the server should listen to # Port the server should listen to
@ -13,14 +13,14 @@ port: 3000
# --------------------------------------------------------------------- # ---------------------------------------------------------------------
# Database # Database
# --------------------------------------------------------------------- # ---------------------------------------------------------------------
# PostgreSQL 9.6 or later required # PostgreSQL 11 or later required
db: db:
host: localhost host: localhost
port: 5432 port: 5432
user: wikijs user: postgres
pass: wikijsrocks pass: postgres
db: wiki db: postgres
schemas: schemas:
wiki: wiki wiki: wiki
scheduler: scheduler scheduler: scheduler

Loading…
Cancel
Save