summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--docs/configuration-config-file.md2
-rw-r--r--docs/configuration-env-vars.md2
-rw-r--r--docs/setup/manual-setup.md19
-rw-r--r--public/views/codimd/head.ejs1
-rw-r--r--public/views/includes/header.ejs2
-rw-r--r--public/views/includes/scripts.ejs4
-rw-r--r--public/views/index/head.ejs1
-rw-r--r--public/views/pretty.ejs1
-rw-r--r--public/views/slide.ejs1
-rw-r--r--webpack.common.js2
-rw-r--r--webpack.htmlexport.js2
-rw-r--r--webpack.prod.js2
12 files changed, 24 insertions, 15 deletions
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md
index d24abce6..c1114549 100644
--- a/docs/configuration-config-file.md
+++ b/docs/configuration-config-file.md
@@ -104,7 +104,7 @@ these are rarely used for various reasons.
| variables | example values | description |
| --------- | ------ | ----------- |
| `email` | `true` or `false` | Set to allow email sign-in. The default is `true`. |
-| `allowEmailRegister` | `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. This setting has no effect if `email` is `false`. The default for `allowEmailRegister` is `true`. |
+| `allowEmailRegister` | `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` is `false`. The default for `allowEmailRegister` is `true`. |
### Dropbox Login
diff --git a/docs/configuration-env-vars.md b/docs/configuration-env-vars.md
index 84155847..bffc2731 100644
--- a/docs/configuration-env-vars.md
+++ b/docs/configuration-env-vars.md
@@ -91,7 +91,7 @@ defaultNotePath can't be set from env-vars
| variable | example value | description |
| -------- | ------------- | ----------- |
| `CMD_EMAIL` | `true` or `false` | Set to allow email sign-in. The default is `true`. |
-| `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. This setting has no effect if `CMD_EMAIL` is `false`. The default for `CMD_ALLOW_EMAIL_REGISTER` is `true`. |
+| `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 `CMD_EMAIL` is `false`. The default for `CMD_ALLOW_EMAIL_REGISTER` is `true`. |
### Dropbox Login
diff --git a/docs/setup/manual-setup.md b/docs/setup/manual-setup.md
index e13a6f12..4aad56a6 100644
--- a/docs/setup/manual-setup.md
+++ b/docs/setup/manual-setup.md
@@ -4,7 +4,9 @@ Manual Installation
## Requirements on your server
- Node.js 8.5 or up
-- Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL) use charset `utf8`
+- Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL). Must use charset `utf8`: this is typically the
+ default in PostgreSQL and SQLite, while in MySQL and MariaDB utf8 might need to be set with
+ `alter database <DBNAME> character set utf8 collate utf8_bin;`
- npm (and its dependencies, [node-gyp](https://github.com/nodejs/node-gyp#installation))
- yarn
- Bash (for the setup script)
@@ -16,12 +18,15 @@ Manual Installation
1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server).
2. Clone this repository (preferred) or download a release and unzip it.
3. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs.
-4. Setup the configs, see more below
-5. Setup environment variables which will overwrite the configs
+4. Modify `config.json`, see docs [here](https://github.com/codimd/server/blob/master/docs/configuration-config-file.md).
+5. Instead of modifying `config.json`, it's possible to configure CodiMD through environment variables which will
+ overwrite the configs, see docs [here](https://github.com/codimd/server/blob/master/docs/configuration-env-vars.md).
6. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development)
-7. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string
- For example: `postgres://username:password@localhost:5432/codimd`
-8. It is recommended to start your server manually once: `yarn start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
+7. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string. For example:
+ - `postgres://username:password@localhost:5432/codimd`
+ - `mysql://username:password@localhost:3306/codimd`
+ - `sqlite://:memory:`
+8. It is recommended to start your server manually once: `npm start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
9. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts)
@@ -35,5 +40,5 @@ If you are upgrading CodiMD from an older version, follow these steps:
4. `git pull` or unzip a new release in the directory.
5. Run `bin/setup`. This will take care of installing dependencies. It is safe to run on an existing installation.
6. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development).
-7. It is recommended to start your server manually once: `yarn start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
+7. It is recommended to start your server manually once: `npm start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
8. You can now restart the CodiMD server!
diff --git a/public/views/codimd/head.ejs b/public/views/codimd/head.ejs
index 934767f6..71e261fb 100644
--- a/public/views/codimd/head.ejs
+++ b/public/views/codimd/head.ejs
@@ -12,6 +12,7 @@
<meta property="og:image:alt" content="CodiMD logo">
<meta property="og:image:type" content="image/png">
<% } %>
+<base href="<%- serverURL %>/">
<title><%= title %></title>
<link rel="icon" type="image/png" href="<%- serverURL %>/favicon.png">
<link rel="apple-touch-icon" href="<%- serverURL %>/apple-touch-icon.png">
diff --git a/public/views/includes/header.ejs b/public/views/includes/header.ejs
index 942a89f9..89f3a0d1 100644
--- a/public/views/includes/header.ejs
+++ b/public/views/includes/header.ejs
@@ -1,3 +1,3 @@
<% for (var css in htmlWebpackPlugin.files.css) { %>
-<link href="<%= webpackConfig.output.baseUrl %><%= htmlWebpackPlugin.files.css[css] %>" rel="stylesheet">
+<link href="<%= htmlWebpackPlugin.files.css[css] %>" rel="stylesheet">
<% } %>
diff --git a/public/views/includes/scripts.ejs b/public/views/includes/scripts.ejs
index c4f5aa5a..259330af 100644
--- a/public/views/includes/scripts.ejs
+++ b/public/views/includes/scripts.ejs
@@ -1,4 +1,4 @@
-<script src="<%= webpackConfig.output.baseUrl %>/config"></script>
+<script src="config"></script>
<% for (var js in htmlWebpackPlugin.files.js) { %>
-<script src="<%= webpackConfig.output.baseUrl %><%= htmlWebpackPlugin.files.js[js] %>" defer></script>
+<script src="<%= htmlWebpackPlugin.files.js[js] %>" defer></script>
<% } %>
diff --git a/public/views/index/head.ejs b/public/views/index/head.ejs
index 0f1e584e..66396adb 100644
--- a/public/views/index/head.ejs
+++ b/public/views/index/head.ejs
@@ -13,6 +13,7 @@
<meta property="og:image" content="<%- serverURL %>/codimd-icon-1024.png">
<meta property="og:image:alt" content="CodiMD logo">
<meta property="og:image:type" content="image/png">
+<base href="<%- serverURL %>/">
<title>CodiMD - <%= __('Collaborative markdown notes') %></title>
<link rel="icon" type="image/png" href="<%- serverURL %>/favicon.png">
<link rel="apple-touch-icon" href="<%- serverURL %>/apple-touch-icon.png">
diff --git a/public/views/pretty.ejs b/public/views/pretty.ejs
index 20bb44e3..0ae62bf9 100644
--- a/public/views/pretty.ejs
+++ b/public/views/pretty.ejs
@@ -22,6 +22,7 @@
<meta property="og:image:alt" content="CodiMD logo">
<meta property="og:image:type" content="image/png">
<% } %>
+ <base href="<%- serverURL %>/">
<title><%= title %></title>
<link rel="icon" type="image/png" href="<%- serverURL %>/favicon.png">
<link rel="apple-touch-icon" href="<%- serverURL %>/apple-touch-icon.png">
diff --git a/public/views/slide.ejs b/public/views/slide.ejs
index 3331b85d..9fefe4b4 100644
--- a/public/views/slide.ejs
+++ b/public/views/slide.ejs
@@ -11,6 +11,7 @@
<% if(typeof description !== 'undefined' && description) { %>
<meta name="description" content="<%= description %>">
<% } %>
+ <base href="<%- serverURL %>/">
<title><%= title %></title>
<link rel="icon" type="image/png" href="<%- serverURL %>/favicon.png">
<link rel="apple-touch-icon" href="<%- serverURL %>/apple-touch-icon.png">
diff --git a/webpack.common.js b/webpack.common.js
index 0aae309d..7b4cefd6 100644
--- a/webpack.common.js
+++ b/webpack.common.js
@@ -352,7 +352,7 @@ module.exports = {
output: {
path: path.join(__dirname, 'public/build'),
- publicPath: '/build/',
+ publicPath: 'build/',
filename: '[name].js'
},
diff --git a/webpack.htmlexport.js b/webpack.htmlexport.js
index dd6f4c01..2aa2bc4f 100644
--- a/webpack.htmlexport.js
+++ b/webpack.htmlexport.js
@@ -14,7 +14,7 @@ module.exports = {
},
output: {
path: path.join(__dirname, 'public/build'),
- publicPath: '/build/',
+ publicPath: 'build/',
filename: '[name].js'
},
plugins: [
diff --git a/webpack.prod.js b/webpack.prod.js
index 188d9881..4dfac1a8 100644
--- a/webpack.prod.js
+++ b/webpack.prod.js
@@ -9,7 +9,7 @@ module.exports = [
mode: 'production',
output: {
path: path.join(__dirname, 'public/build'),
- publicPath: '/build/',
+ publicPath: 'build/',
filename: '[name].[contenthash].js'
}
}),
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-29 13:50:05 +0000