github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-04-14 22:33:30 +00:00
Code Issues Projects Releases Packages Wiki Activity

refactor: lint markdown

Browse source 
Signed-off-by: oupala <oupala@users.noreply.github.com>
This commit is contained in:
oupala 2020-06-15 16:48:21 +02:00
parent e46d520ca2
commit 65fc44e32f
1 changed files with 1 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/configuration.md
View file

@ -1,5 +1,4 @@
Configuration
===
# Configuration
You can choose to configure CodiMD with either a config file or with environment variables.
@ -16,7 +15,6 @@ to `config.json` before filling in your own details.
| | `NODE_ENV` | `production` or `development` | set current environment (will apply corresponding settings in the `config.json`) |
| `debug` | `DEBUG` | `true` or `false` | set debug mode, show more logs |
## CodiMD basics
| config file | environment | example value | description |
@ -35,7 +33,6 @@ to `config.json` before filling in your own details.
| `heartbeatTimeout` | | `10000` | socket.io heartbeat timeout |
| `documentMaxLength` | | `100000` | note max length |
## CodiMD paths stuff
these are rarely used for various reasons.
@ -52,7 +49,6 @@ these are rarely used for various reasons.
| `viewPath` | | `./public/views` | template directory path<sup>1</sup> |
| `uploadsPath` | | `./public/uploads` | uploads directory<sup>1</sup> - needs to be persistent when you use imageUploadType `filesystem` |
## CodiMD Location
| config file | environment | example value | description |
@ -67,7 +63,6 @@ these are rarely used for various reasons.
| `urlAddPort` | `CMD_URL_ADDPORT` | `true` or `false` | set to add port on callback URL (ports `80` or `443` won't be applied) (only applied when domain is set) |
| `allowOrigin` | `CMD_ALLOW_ORIGIN` | `['localhost']`, `['codimd.org']`, `localhost, codimd.org` | domain name whitelist (use comma to separate) |
## CSP and HSTS
| config file | environment | example value | description |
@ -81,7 +76,6 @@ these are rarely used for various reasons.
| | `CMD_CSP_ENABLE` | `true` | whether to enable Content Security Policy (directives cannot be configured with environment variables) |
| `CMD_CSP_REPORTURI` | `https://<someid>.report-uri.com/r/d/csp/enforce` | Allows to add a URL for CSP reports in case of violations | |
## Privacy and External Requests
| config file | environment | example value | description |
@ -89,7 +83,6 @@ these are rarely used for various reasons.
| `allowGravatar` | `CMD_ALLOW_GRAVATAR` | `true` or `false` | set to `false` to disable [Libravatar](https://www.libravatar.org/) as profile picture source on your instance. Libravatar is a federated open-source alternative to Gravatar. |
| `useCDN` | `CMD_USECDN` | `true` or `false` | set to use CDN resources or not (default is `false`) |
## Users and Privileges
| config file | environment | example value | description |
@ -102,7 +95,6 @@ these are rarely used for various reasons.
| `sessionLife` | `CMD_SESSION_LIFE` | `14 * 24 * 60 * 60 * 1000`, `1209600000` (14 days) | Cookie session life time in milliseconds. |
| `sessionSecret` | `CMD_SESSION_SECRET` | `secret` | Cookie session secret used to sign the session cookie. If none is set, one will randomly generated on each startup, meaning all your users will be logged out. |
## Login methods
### Email (local account)
@ -112,7 +104,6 @@ these are rarely used for various reasons.
| `email` | `CMD_EMAIL` | `true` or `false` | Set to allow email sign-in. The default is `true`. |
| `allowEmailRegister` | `CMD_ALLOW_EMAIL_REGISTER` | `true` or `false` | Set to allow registration of new accounts using an email address. If set to `false`, you can still create accounts using the command line - see `bin/manage_users` for details (In production mode, remember to run it with `NODE_ENV` set as `production` in the enviroment). This setting has no effect if `email` or `CMD_EMAIL` is `false`. The default for `allowEmailRegister` or `CMD_ALLOW_EMAIL_REGISTER` is `true`. |
### Dropbox Login
| config file | environment | example value | description |
@ -129,7 +120,6 @@ these are rarely used for various reasons.
| | `CMD_FACEBOOK_CLIENTID` | no example | Facebook API client id |
| | `CMD_FACEBOOK_CLIENTSECRET` | no example | Facebook API client secret |
### GitHub Login
| config file | environment | example value | description |
@ -138,7 +128,6 @@ these are rarely used for various reasons.
| | `CMD_GITHUB_CLIENTID` | no example | GitHub API client id |
| | `CMD_GITHUB_CLIENTSECRET` | no example | GitHub API client secret |
### GitLab Login
| config file | environment | example value | description |
@ -150,7 +139,6 @@ these are rarely used for various reasons.
| | `CMD_GITLAB_CLIENTSECRET` | no example | GitLab API client secret |
| | `CMD_GITLAB_VERSION` | no example | GitLab API version (v3 or v4) |
### Google Login
| config file | environment | example value | description |
@ -160,7 +148,6 @@ these are rarely used for various reasons.
| | `CMD_GOOGLE_CLIENTSECRET` | no example | Google API client secret |
| | `CMD_GOOGLE_HOSTEDDOMAIN` | `example.com` | Provided only if the user belongs to a hosted domain. default is `undefined` |
### LDAP Login
| config file | environment | example value | description |
@ -177,7 +164,6 @@ these are rarely used for various reasons.
| | `CMD_LDAP_TLS_CA` | `server-cert.pem, root.pem` | Root CA for LDAP TLS in PEM format (use comma to separate) |
| | `CMD_LDAP_PROVIDERNAME` | `My institution` | Optional name to be displayed at login form indicating the LDAP provider |
### Mattermost Login
| config file | environment | example value | description |
@ -187,7 +173,6 @@ these are rarely used for various reasons.
| | `CMD_MATTERMOST_CLIENTID` | no example | Mattermost API client id |
| | `CMD_MATTERMOST_CLIENTSECRET` | no example | Mattermost API client secret |
### OAuth2 Login
| config file | environment | example value | description |
@ -203,7 +188,6 @@ these are rarely used for various reasons.
| | `CMD_OAUTH2_CLIENT_SECRET` | `afae02fckafd...` | you will get this from your OAuth2 provider when you register CodiMD as OAuth2-client, (no default value) |
| | `CMD_OAUTH2_PROVIDERNAME` | `My institution` | Optional name to be displayed at login form indicating the oAuth2 provider |
### SAML Login
| config file | environment | example value | description |
@ -221,7 +205,6 @@ these are rarely used for various reasons.
| | `CMD_SAML_ATTRIBUTE_USERNAME` | `mailNickname` | attribute map for `username` (optional, default: NameID of SAML response) |
| | `CMD_SAML_ATTRIBUTE_EMAIL` | `mail` | attribute map for `email` (optional, default: NameID of SAML response if `CMD_SAML_IDENTIFIERFORMAT` is default) |
### Twitter Login
| config file | environment | example value | description |
@ -230,14 +213,12 @@ these are rarely used for various reasons.
| | `CMD_TWITTER_CONSUMERKEY` | no example | Twitter API consumer key |
| | `CMD_TWITTER_CONSUMERSECRET` | no example | Twitter API consumer secret |
## Upload Storage
These are only relevant when they are also configured in sync with their
`CMD_IMAGE_UPLOAD_TYPE`. Also keep in mind, that `filesystem` is available, so
you don't have to use either of these.
### Amazon S3
| config file | environment | example value | description |
@ -248,7 +229,6 @@ you don't have to use either of these.
| | `CMD_S3_REGION` | `ap-northeast-1` | AWS S3 region |
| `s3bucket` | `CMD_S3_BUCKET` | no example | AWS S3 bucket name |
### Azure Blob Storage
| config file | environment | example value | description |
@ -256,14 +236,12 @@ you don't have to use either of these.
| | `CMD_AZURE_CONNECTION_STRING` | no example | Azure Blob Storage connection string |
| | `CMD_AZURE_CONTAINER` | no example | Azure Blob Storage container name (automatically created if non existent) |
### imgur
| config file | environment | example value | description |
| ----------- | -------------------- | ------------- | ------------------- |
| | `CMD_IMGUR_CLIENTID` | no example | Imgur API client id |
### Minio
| config file | environment | example value | description |
@ -275,7 +253,6 @@ you don't have to use either of these.
| | `CMD_MINIO_PORT` | `9000` | Port that is used for your Minio instance |
| | `CMD_MINIO_SECURE` | `true` | If set to `true` HTTPS is used for Minio |
### Lutim
| config file | environment | example value | description |