6.6 KiB
6.6 KiB
Configuration Using Config file
You can choose to configure CodiMD with either a config file or with
environment variables. The config file is processed
in lib/config/index.js - so this is the first
place to look if anything is missing not obvious from this document.
Environment variables take precedence over configurations from the config files.
To get started, it is a good idea to take the config.json.example and copy it
to config.json before filling in your own details.
| variables | example values | description |
|---|---|---|
debug |
true or false |
set debug mode, show more logs |
domain |
localhost |
domain name |
urlPath |
codimd |
sub URL path, like www.example.com/<urlpath> |
host |
localhost |
host to listen on |
port |
80 |
web app port |
path |
/var/run/codimd.sock |
path to UNIX domain socket to listen on (if specified, host and port are ignored) |
loglevel |
info |
Defines what kind of logs are provided to stdout. |
allowOrigin |
['localhost'] |
domain name whitelist |
useSSL |
true or false |
set to use SSL server (if true, will auto turn on protocolUseSSL) |
hsts |
{"enable": true, "maxAgeSeconds": 31536000, "includeSubdomains": true, "preload": true} |
HSTS options to use with HTTPS (default is the example value, max age is a year) |
csp |
{"enable": true, "directives": {"scriptSrc": "trustworthy-scripts.example.com"}, "upgradeInsecureRequests": "auto", "addDefaults": true} |
Configures Content Security Policy. Directives are passed to Helmet - see their documentation for more information on the format. Some defaults are added to the configured values so that the application doesn't break. To disable this behaviour, set addDefaults to false. Further, if usecdn is on, some CDN locations are allowed too. By default (auto), insecure (HTTP) requests are upgraded to HTTPS via CSP if useSSL is on. To change this behaviour, set upgradeInsecureRequests to either true or false. |
protocolUseSSL |
true or false |
set to use SSL protocol for resources path (only applied when domain is set) |
urlAddPort |
true or false |
set to add port on callback URL (ports 80 or 443 won't be applied) (only applied when domain is set) |
useCDN |
true or false |
set to use CDN resources or not (default is true) |
allowAnonymous |
true or false |
set to allow anonymous usage (default is true) |
allowAnonymousEdits |
true or false |
if allowAnonymous is true: allow users to select freely permission, allowing guests to edit existing notes (default is false) |
allowFreeURL |
true or false |
set to allow new note creation by accessing a nonexistent note URL |
forbiddenNoteIDs |
['robots.txt'] |
disallow creation of notes, even if allowFreeUrl is true |
defaultPermission |
freely, editable, limited, locked, protected or private |
set notes default permission (only applied on signed users) |
dbURL |
mysql://localhost:3306/database |
set the db URL; if set, then db config (below) won't be applied |
db |
{ "dialect": "sqlite", "storage": "./db.codimd.sqlite" } |
set the db configs, see more here |
sslKeyPath |
./cert/client.key |
SSL key path1 (only need when you set useSSL) |
sslCertPath |
./cert/codimd_io.crt |
SSL cert path1 (only need when you set useSSL) |
sslCAPath |
['./cert/COMODORSAAddTrustCA.crt'] |
SSL ca chain1 (only need when you set useSSL) |
dhParamPath |
./cert/dhparam.pem |
SSL dhparam path1 (only need when you set useSSL) |
tmpPath |
./tmp/ |
temp directory path1 |
defaultNotePath |
./public/default.md |
default note file path1 |
docsPath |
./public/docs |
docs directory path1 |
viewPath |
./public/views |
template directory path1 |
uploadsPath |
./public/uploads |
uploads directory1 - needs to be persistent when you use imageUploadType filesystem |
sessionName |
connect.sid |
cookie session name |
sessionSecret |
secret |
cookie session secret |
sessionLife |
14 * 24 * 60 * 60 * 1000 |
cookie session life |
staticCacheTime |
1 * 24 * 60 * 60 * 1000 |
static file cache time |
heartbeatInterval |
5000 |
socket.io heartbeat interval |
heartbeatTimeout |
10000 |
socket.io heartbeat timeout |
documentMaxLength |
100000 |
note max length |
email |
true or false |
set to allow email signin |
oauth2 |
{baseURL: ..., userProfileURL: ..., userProfileUsernameAttr: ..., userProfileDisplayNameAttr: ..., userProfileEmailAttr: ..., tokenURL: ..., authorizationURL: ..., clientID: ..., clientSecret: ...} |
An object detailing your OAuth2 provider. Refer to the Mattermost or Nextcloud examples for more details! |
allowEmailRegister |
true or false |
set to allow email register (only applied when email is set, default is true. Note bin/manage_users might help you if registration is false.) |
allowGravatar |
true or false |
set to false to disable gravatar as profile picture source on your instance |
imageUploadType |
imgur, s3, minio, azure or filesystem(default) |
Where to upload images. For S3, see our Image Upload Guides for S3 or Minio |
minio |
{ "accessKey": "YOUR_MINIO_ACCESS_KEY", "secretKey": "YOUR_MINIO_SECRET_KEY", "endpoint": "YOUR_MINIO_HOST", port: 9000, secure: true } |
When imageUploadType is set to minio, you need to set this key. Also checkout our Minio Image Upload Guide |
s3 |
{ "accessKeyId": "YOUR_S3_ACCESS_KEY_ID", "secretAccessKey": "YOUR_S3_ACCESS_KEY", "region": "YOUR_S3_REGION" } |
When imageuploadtype be set to s3, you would also need to setup this key, check our S3 Image Upload Guide |
s3bucket |
YOUR_S3_BUCKET_NAME |
bucket name when imageUploadType is set to s3 or minio |
sourceURL |
https://github.com/codimd/server/tree/<current commit> |
Provides the link to the source code of CodiMD on the entry page (Please, make sure you change this when you run a modified version) |
1: relative paths are based on CodiMD's base directory