Pad Thing with CodiMD - Revision history

320x200: /* Notes */

2019-02-25T13:57:38Z

Notes

← Older revision		Revision as of 13:57, 25 February 2019
Line 105:		Line 105:

	== Notes ==		== Notes ==
	* Configuration in CodiMD is a bit inconsistent, some settings ~~exits~~ in several places (like the db stuff, why???), and even though <code>env</code> variables are mirroring the config.json keys, some of these options will only work if passed as <code>env</code> variables... For instance <code>"useCDN": "false"</code> does not work, but <code>CMD_USECDN="false"</code> does.		* Configuration in CodiMD is a bit inconsistent, some settings exist in several places (like the db stuff, why???), and even though <code>env</code> variables are mirroring the config.json keys, some of these options will only work if passed as <code>env</code> variables... For instance <code>"useCDN": "false"</code> does not work, but <code>CMD_USECDN="false"</code> does.
	* By default client files, including the upload folder, will live inside the CodiMD folder, it can be moved elsewhere though, there are several options for setting various paths		* By default client files, including the upload folder, will live inside the CodiMD folder, it can be moved elsewhere though, there are several options for setting various paths
	* <code>"useCDN": "false"</code> and <code>CMD_USECDN="false"</code> will prevent pulling stuff from various CDN, and serve the needed files from your server directly, which is nice. Similarly it's possible to disable Gravatar for registered users.		* <code>"useCDN": "false"</code> and <code>CMD_USECDN="false"</code> will prevent pulling stuff from various CDN, and serve the needed files from your server directly, which is nice. Similarly it's possible to disable Gravatar for registered users.

320x200: /* Notes */

2019-02-25T13:55:00Z

Notes

← Older revision		Revision as of 13:55, 25 February 2019
Line 107:		Line 107:
	* Configuration in CodiMD is a bit inconsistent, some settings exits in several places (like the db stuff, why???), and even though <code>env</code> variables are mirroring the config.json keys, some of these options will only work if passed as <code>env</code> variables... For instance <code>"useCDN": "false"</code> does not work, but <code>CMD_USECDN="false"</code> does.		* Configuration in CodiMD is a bit inconsistent, some settings exits in several places (like the db stuff, why???), and even though <code>env</code> variables are mirroring the config.json keys, some of these options will only work if passed as <code>env</code> variables... For instance <code>"useCDN": "false"</code> does not work, but <code>CMD_USECDN="false"</code> does.
	* By default client files, including the upload folder, will live inside the CodiMD folder, it can be moved elsewhere though, there are several options for setting various paths		* By default client files, including the upload folder, will live inside the CodiMD folder, it can be moved elsewhere though, there are several options for setting various paths
	* <code>"useCDN": "false"</code> and <code>CMD_USECDN="false"</code> will prevent pulling stuff from various CDN, and serve the needed files from your server directly, which is nice. Similarly it's possible to disable Gravatar for registered ~~user~~.		* <code>"useCDN": "false"</code> and <code>CMD_USECDN="false"</code> will prevent pulling stuff from various CDN, and serve the needed files from your server directly, which is nice. Similarly it's possible to disable Gravatar for registered users.
	* You can set <code>debug</code> to <code>true</code> in <code>config.json</code> if you need more verbose output when trying things out		* You can set <code>debug</code> to <code>true</code> in <code>config.json</code> if you need more verbose output when trying things out

	[[Category: Web Application]]		[[Category: Web Application]]

320x200: /* Notes */

2019-02-25T13:52:42Z

Notes

← Older revision		Revision as of 13:52, 25 February 2019
Line 108:		Line 108:
	* By default client files, including the upload folder, will live inside the CodiMD folder, it can be moved elsewhere though, there are several options for setting various paths		* By default client files, including the upload folder, will live inside the CodiMD folder, it can be moved elsewhere though, there are several options for setting various paths
	* <code>"useCDN": "false"</code> and <code>CMD_USECDN="false"</code> will prevent pulling stuff from various CDN, and serve the needed files from your server directly, which is nice. Similarly it's possible to disable Gravatar for registered user.		* <code>"useCDN": "false"</code> and <code>CMD_USECDN="false"</code> will prevent pulling stuff from various CDN, and serve the needed files from your server directly, which is nice. Similarly it's possible to disable Gravatar for registered user.
	* You can set <code>debug</code> to <code>true</code> if you need more verbose output when trying things out		* You can set <code>debug</code> to <code>true</code> in <code>config.json</code> if you need more verbose output when trying things out

	[[Category: Web Application]]		[[Category: Web Application]]

320x200: /* Notes */

2019-02-25T13:52:18Z

Notes

← Older revision		Revision as of 13:52, 25 February 2019
Line 108:		Line 108:
	* By default client files, including the upload folder, will live inside the CodiMD folder, it can be moved elsewhere though, there are several options for setting various paths		* By default client files, including the upload folder, will live inside the CodiMD folder, it can be moved elsewhere though, there are several options for setting various paths
	* <code>"useCDN": "false"</code> and <code>CMD_USECDN="false"</code> will prevent pulling stuff from various CDN, and serve the needed files from your server directly, which is nice. Similarly it's possible to disable Gravatar for registered user.		* <code>"useCDN": "false"</code> and <code>CMD_USECDN="false"</code> will prevent pulling stuff from various CDN, and serve the needed files from your server directly, which is nice. Similarly it's possible to disable Gravatar for registered user.
			* You can set <code>debug</code> to <code>true</code> if you need more verbose output when trying things out

	[[Category: Web Application]]		[[Category: Web Application]]

320x200 at 13:50, 25 February 2019

2019-02-25T13:50:58Z

← Older revision		Revision as of 13:50, 25 February 2019
Line 1:		Line 1:
	CodiMD is a browser-based real-time collaborative markdown notes/pad kind of thing.		[[File:Screenshot-CodiMD-default.png\|right\|600px]]
			'''CodiMD''' is a browser-based real-time collaborative markdown notes/pad kind of thing.

	== Prerequisites ==		== Prerequisites ==

320x200: /* Running CodiMD */

2019-02-25T13:44:11Z

Running CodiMD

← Older revision		Revision as of 13:44, 25 February 2019
Line 98:		Line 98:
	su pooruser -s /bin/sh		su pooruser -s /bin/sh
	* start CodiMD like this:		* start CodiMD like this:
	NODE_ENV="production" CMD_USECDN="false" node app.js		NODE_ENV="production" CMD_USECDN="false" CMD_ALLOW_GRAVATAR="false" node app.js

	=== As a systemd service ===		=== As a systemd service ===

320x200: /* Installation and Configuration */

2019-02-25T13:42:43Z

Installation and Configuration

← Older revision		Revision as of 13:42, 25 February 2019
Line 62:		Line 62:
	* Build		* Build
	npm run build		npm run build
			* prepare database:
			node_modules/.bin/sequelize db:migrate
	* Make a site entry for you NGINX config, something along those lines:		* Make a site entry for you NGINX config, something along those lines:
	server {		server {

320x200: /* Testing from the shell */

2019-02-25T13:36:03Z

Testing from the shell

← Older revision		Revision as of 13:36, 25 February 2019
Line 92:		Line 92:
	== Running CodiMD ==		== Running CodiMD ==
	=== Testing from the shell ===		=== Testing from the shell ===
			(Or running from <code>screen</code>/<code>tmux</code>)
			* su as your limited rights user:
			su pooruser -s /bin/sh
			* start CodiMD like this:
			NODE_ENV="production" CMD_USECDN="false" node app.js

	=== As a systemd service ===		=== As a systemd service ===

320x200: /* Prerequisites */

2019-02-25T13:33:30Z

Prerequisites

← Older revision		Revision as of 13:33, 25 February 2019
Line 3:		Line 3:
	== Prerequisites ==		== Prerequisites ==
	* Node v8.x https://nodejs.org/dist/latest-v8.x (tested with v8.15, [https://github.com/hackmdio/codimd/issues/1132 support for v10.x is on the way])		* Node v8.x https://nodejs.org/dist/latest-v8.x (tested with v8.15, [https://github.com/hackmdio/codimd/issues/1132 support for v10.x is on the way])
	* [[MySQL Databases\|A MySQL database]]		* [[MySQL Databases\|A MySQL database]], for now it only works with an utf8 db, specifically <code>CHARACTER SET = utf8 COLLATE = utf8_general_ci</code>
	* a user with limited rights		* a user with limited rights
	* SSL certs		* SSL certs

320x200: /* Installation and Configuration */

2019-02-25T13:31:54Z

Installation and Configuration

@@ Line 62: / Line 62: @@
 * Build
   npm run build
 [[Category: Web Application]]