From 3709b8e7bea1141824d8622e772660a2a8820d45 Mon Sep 17 00:00:00 2001 From: Nicolas Giard Date: Sun, 22 Oct 2017 13:23:40 -0400 Subject: [PATCH 1/2] docs: updated README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a92eb2d2..cb307582 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ Current and upcoming milestones *(major features only, see the [changelog](https ## Gitter -Want to discuss features, ideas or issues? Join our [gitter channel](https://gitter.im/Requarks/wiki). We are very active and friendly! +Want to discuss features, ideas or issues? Join our [gitter channel](https://gitter.im/Requarks/wiki). We are very active and friendly! [![Chat on Gitter](https://img.shields.io/badge/chat-on_gitter-CC2B5E.svg?style=flat-square&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAcAAAAOCAMAAADUg/YpAAAABlBMVEUAAAD///%2Bl2Z/dAAAAAXRSTlMAQObYZgAAABVJREFUeAFjwAUYYTQByAAh0WicAAAFnwAYeB5bLwAAAABJRU5ErkJggg==)](https://gitter.im/Requarks/wiki) ## Twitter From 0a22bb5ee5404042c11f92a668a302cceaa982d0 Mon Sep 17 00:00:00 2001 From: Nicolas Giard Date: Sun, 22 Oct 2017 13:24:43 -0400 Subject: [PATCH 2/2] fix: revert to 1.x config sample --- config.sample.yml | 160 +++++++++++++++++++++++++++++++++++++++------- 1 file changed, 138 insertions(+), 22 deletions(-) diff --git a/config.sample.yml b/config.sample.yml index 5421d5a8..aa1e7c0a 100644 --- a/config.sample.yml +++ b/config.sample.yml @@ -5,9 +5,23 @@ # https://docs.requarks.io/wiki/install # --------------------------------------------------------------------- -# Port the main server should listen to +# Title of this site # --------------------------------------------------------------------- +title: Wiki + +# --------------------------------------------------------------------- +# Full public path to the site, without the trailing slash +# --------------------------------------------------------------------- +# INCLUDE CLIENT PORT IF NOT 80/443! + +host: http://localhost + +# --------------------------------------------------------------------- +# Port the main server should listen to (80 by default) +# --------------------------------------------------------------------- +# To use process.env.PORT, comment the line below: + port: 80 # --------------------------------------------------------------------- @@ -19,38 +33,140 @@ paths: data: ./data # --------------------------------------------------------------------- -# Database +# Upload Limits +# --------------------------------------------------------------------- +# In megabytes (MB) + +uploads: + maxImageFileSize: 3 + maxOtherFileSize: 100 + +# --------------------------------------------------------------------- +# Site Language +# --------------------------------------------------------------------- +# Possible values: en, de, es, fa, fr, ja, ko, nl, pt, ru, sr, tr or zh + +lang: en + +# Enable for right to left languages (e.g. arabic): +langRtl: false + +# --------------------------------------------------------------------- +# Site Authentication +# --------------------------------------------------------------------- + +public: false + +auth: + defaultReadAccess: false + local: + enabled: true + google: + enabled: true + clientId: GOOGLE_CLIENT_ID + clientSecret: GOOGLE_CLIENT_SECRET + microsoft: + enabled: true + clientId: MS_APP_ID + clientSecret: MS_APP_SECRET + facebook: + enabled: false + clientId: FACEBOOK_APP_ID + clientSecret: FACEBOOK_APP_SECRET + github: + enabled: false + clientId: GITHUB_CLIENT_ID + clientSecret: GITHUB_CLIENT_SECRET + slack: + enabled: false + clientId: 'SLACK_CLIENT_ID' + clientSecret: 'SLACK_CLIENT_SECRET' + ldap: + enabled: false + url: ldap://serverhost:389 + bindDn: cn='root' + bindCredentials: BIND_PASSWORD + searchBase: o=users,o=example.com + searchFilter: (uid={{username}}) + tlsEnabled: false + tlsCertPath: C:\example\root_ca_cert.crt + azure: + enabled: false + clientId: APP_ID + clientSecret: APP_SECRET_KEY + resource: '00000002-0000-0000-c000-000000000000' + tenant: 'YOUR_TENANT.onmicrosoft.com' + +# --------------------------------------------------------------------- +# Secret key to use when encrypting sessions +# --------------------------------------------------------------------- +# Use a long and unique random string (256-bit keys are perfect!) + +sessionSecret: 1234567890abcdefghijklmnopqrstuvxyz + +# --------------------------------------------------------------------- +# Database Connection String +# --------------------------------------------------------------------- +# You can also use an ENV variable by using $ENV_VAR_NAME as the value + +db: mongodb://localhost:27017/wiki + +# --------------------------------------------------------------------- +# Git Connection Info # --------------------------------------------------------------------- -db: - host: localhost - port: 5432 - user: wikijs - pass: wikijsrocks - db: wiki +git: + url: https://github.com/Organization/Repo + branch: master + auth: + + # Type: basic or ssh + type: ssh + + # Only for Basic authentication: + username: marty + password: MartyMcFly88 + + # Only for SSH authentication: + privateKey: /etc/wiki/keys/git.pem + + sslVerify: true + + # Default email to use as commit author + serverEmail: marty@example.com + + # Whether to use user email as author in commits + showUserEmail: true # --------------------------------------------------------------------- -# Redis +# Features # --------------------------------------------------------------------- +# You can enable / disable specific features below -redis: - host: localhost - port: 6379 - db: 0 - password: null +features: + linebreaks: true + mathjax: true # --------------------------------------------------------------------- -# Background Workers +# External Logging # --------------------------------------------------------------------- -# Leave 0 for auto based on CPU cores -workers: 0 +externalLogging: + bugsnag: false + loggly: false + papertrail: false + rollbar: false + sentry: false # --------------------------------------------------------------------- -# High Availability +# Color Theme # --------------------------------------------------------------------- -# Read the docs BEFORE changing these settings! -ha: - nodeuid: primary - readonly: false +theme: + primary: indigo + alt: blue-grey + viewSource: all # all | write | false + footer: blue-grey + code: + dark: true + colorize: true