status-im
/
codimd
mirror of https://github.com/status-im/codimd.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
CodiMD - Realtime collaborative markdown notes on all platforms. https://hackmd.io/c/codimd-documentation
1,275 Commits 23 Branches 35 Tags 26 MiB
JavaScript 75.1%
EJS 12.5%
CSS 9.8%
HTML 1.1%
Handlebars 1%
Other 0.5%
Go to file
butlerx e5834c077f
add the ability to set slide theme in slide options 		2017-05-31 23:28:43 +01:00
bin Remove npm install in heroku build 2017-05-07 18:54:18 +08:00
docs/guides Update README 2016-11-17 18:27:53 +08:00
lib add the ability to set slide theme in slide options 2017-05-31 23:28:43 +01:00
locales Fixed style in promo text 2017-03-10 19:17:41 +03:00
public add the ability to set slide theme in slide options 2017-05-31 23:28:43 +01:00
tmp Jump to 0.3.1 2015-07-02 00:10:20 +08:00
.babelrc Install vue and babel dependency 2016-12-24 11:10:18 +08:00
.editorconfig Update editorconfig 2017-03-31 20:58:58 +08:00
.gitignore Remove config.js from setup files 2017-01-13 23:37:16 +08:00
.sequelizerc.example Create example config 2016-10-05 10:58:05 +08:00
.travis.yml Move to Ubuntu Trusty on Travis CI and remove apt add-on 2017-04-18 13:17:43 +08:00
AUTHORS Update authors 2017-01-02 11:14:44 +08:00
CONTRIBUTING.md Create CONTRIBUTING.md 2016-09-28 01:39:44 +08:00
LICENSE Update year to 2017 2017-01-02 11:14:25 +08:00
README.md Add defaultpermission protected example value 2017-03-25 17:00:43 +08:00
app.js Fix import module name typo in app.js 2017-05-08 20:35:51 +08:00
app.json Remove redundant HMD_PORT config from app.json 2017-05-14 19:07:56 +08:00
config.json.example Add config option for gitlab api scope and auto adapt gitlab snippet feature on it 2017-03-14 18:04:23 +08:00
package.json Merge branch 'master' into BackendRefactor 2017-05-14 17:42:14 +08:00
webpack.config.js Enable source map in development build 2017-04-11 16:40:13 +08:00
webpack.production.js Use JavaScript Standard Style (part 2) 2017-03-09 02:41:05 +08:00
webpackBaseConfig.js Load statusbar template by string-loader 2017-05-07 20:37:26 +08:00
yarn.lock Merge branch 'master' into BackendRefactor 2017-05-14 17:42:14 +08:00

README.md

HackMD

Standard - JavaScript Style Guide

Join the chat at https://gitter.im/hackmdio/hackmd build status

HackMD lets you create realtime collaborative markdown notes on all platforms.
Inspired by Hackpad, with more focus on speed and flexibility.
Still in the early stage, feel free to fork or contribute to HackMD.

Thanks for using! 😄

docker-hackmd

Before you go too far, here is the great docker repo for HackMD.
With docker, you can deploy a server in minutes without any downtime.

Heroku Deployment

You can quickly setup a sample heroku hackmd application by clicking the button below.

Deploy

migration-to-0.5.0

We don't use LZString to compress socket.io data and DB data after version 0.5.0.
Please run the migration tool if you're upgrading from the old version.

migration-to-0.4.0

We've dropped MongoDB after version 0.4.0.
So here is the migration tool for you to transfer the old DB data to the new DB.
This tool is also used for official service.

Browsers Requirement

  • Chrome >= 47, Chrome for Android >= 47
  • Safari >= 9, iOS Safari >= 8.4
  • Firefox >= 44
  • IE >= 9, Edge >= 12
  • Opera >= 34, Opera Mini not supported
  • Android Browser >= 4.4

Prerequisite

  • Node.js 6.x or up (test up to 7.5.0)
  • Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL) use charset utf8
  • npm (and its dependencies, especially uWebSockets, node-gyp)

Get started

  1. Download a release and unzip or clone into a directory
  2. Enter the directory and type bin/setup, which will install npm dependencies and create configs. The setup script is written in Bash, you would need bash as a prerequisite.
  3. Setup the configs, see more below
  4. Setup environment variables which will overwrite the configs
  5. Build front-end bundle by npm run build (use npm run dev if you are in development)
  6. Run the server as you like (node, forever, pm2)

Upgrade guide

If you are upgrading HackMD from an older version, follow these steps:

  1. Fully stop your old server first (important)
  2. git pull or do whatever that updates the files
  3. npm install to update dependencies
  4. Build front-end bundle by npm run build (use npm run dev if you are in development)
  5. Modify the file named .sequelizerc, change the value of the variable url with your db connection string For example: postgres://username:password@localhost:5432/hackmd
  6. Run node_modules/.bin/sequelize db:migrate, this step will migrate your db to the latest schema
  7. Start your whole new server!

Structure

hackmd/
├── tmp/            --- temporary files
├── docs/           --- document files
├── lib/            --- server libraries
└── public/         --- client files
    ├── css/        --- css styles
    ├── js/         --- js scripts
    ├── vendor/     --- vendor includes
    └── views/      --- view templates

Configuration files

There are some configs you need to change in the files below

./config.json      ----application settings

Environment variables (will overwrite other server configs)

variables example values description
NODE_ENV production or development set current environment (will apply corresponding settings in the config.json)
DEBUG true or false set debug mode, show more logs
HMD_DOMAIN hackmd.io domain name
HMD_URL_PATH hackmd sub url path, like www.example.com/<URL_PATH>
HMD_PORT 80 web app port
HMD_ALLOW_ORIGIN localhost, hackmd.io domain name whitelist (use comma to separate)
HMD_PROTOCOL_USESSL true or false set to use ssl protocol for resources path (only applied when domain is set)
HMD_URL_ADDPORT true or false set to add port on callback url (port 80 or 443 won't applied) (only applied when domain is set)
HMD_USECDN true or false set to use CDN resources or not (default is true)
HMD_ALLOW_ANONYMOUS true or false set to allow anonymous usage (default is true)
HMD_ALLOW_FREEURL true or false set to allow new note by accessing not exist note url
HMD_DEFAULT_PERMISSION freely, editable, limited, locked or private set notes default permission (only applied on signed users)
HMD_DB_URL mysql://localhost:3306/database set the db url
HMD_FACEBOOK_CLIENTID no example Facebook API client id
HMD_FACEBOOK_CLIENTSECRET no example Facebook API client secret
HMD_TWITTER_CONSUMERKEY no example Twitter API consumer key
HMD_TWITTER_CONSUMERSECRET no example Twitter API consumer secret
HMD_GITHUB_CLIENTID no example GitHub API client id
HMD_GITHUB_CLIENTSECRET no example GitHub API client secret
HMD_GITLAB_SCOPE read_user or api GitLab API requested scope (default is api) (gitlab snippet import/export need api scope)
HMD_GITLAB_BASEURL no example GitLab authentication endpoint, set to use other endpoint than GitLab.com (optional)
HMD_GITLAB_CLIENTID no example GitLab API client id
HMD_GITLAB_CLIENTSECRET no example GitLab API client secret
HMD_DROPBOX_CLIENTID no example Dropbox API client id
HMD_DROPBOX_CLIENTSECRET no example Dropbox API client secret
HMD_GOOGLE_CLIENTID no example Google API client id
HMD_GOOGLE_CLIENTSECRET no example Google API client secret
HMD_LDAP_URL ldap://example.com url of LDAP server
HMD_LDAP_BINDDN no example bindDn for LDAP access
HMD_LDAP_BINDCREDENTIALS no example bindCredentials for LDAP access
HMD_LDAP_TOKENSECRET supersecretkey secret used for generating access/refresh tokens
HMD_LDAP_SEARCHBASE o=users,dc=example,dc=com LDAP directory to begin search from
HMD_LDAP_SEARCHFILTER (uid={{username}}) LDAP filter to search with
HMD_LDAP_SEARCHATTRIBUTES no example LDAP attributes to search with
HMD_LDAP_TLS_CA server-cert.pem, root.pem Root CA for LDAP TLS in PEM format (use comma to separate)
HMD_LDAP_PROVIDERNAME My institution Optional name to be displayed at login form indicating the LDAP provider
HMD_IMGUR_CLIENTID no example Imgur API client id
HMD_EMAIL true or false set to allow email signin
HMD_ALLOW_EMAIL_REGISTER true or false set to allow email register (only applied when email is set, default is true)
HMD_IMAGE_UPLOAD_TYPE imgur, s3 or filesystem Where to upload image. For S3, see our S3 Image Upload Guide
HMD_S3_ACCESS_KEY_ID no example AWS access key id
HMD_S3_SECRET_ACCESS_KEY no example AWS secret key
HMD_S3_REGION ap-northeast-1 AWS S3 region
HMD_S3_BUCKET no example AWS S3 bucket name

Application settings config.json

variables example values description
debug true or false set debug mode, show more logs
domain localhost domain name
urlpath hackmd sub url path, like www.example.com/<urlpath>
port 80 web app port
alloworigin ['localhost'] domain name whitelist
usessl true or false set to use ssl server (if true will auto turn on protocolusessl)
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 (port 80 or 443 won't 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)
allowfreeurl true or false set to allow new note by accessing not exist note url
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 this variable then below db config won't be applied
db { "dialect": "sqlite", "storage": "./db.hackmd.sqlite" } set the db configs, see more here
sslkeypath ./cert/client.key ssl key path (only need when you set usessl)
sslcertpath ./cert/hackmd_io.crt ssl cert path (only need when you set usessl)
sslcapath ['./cert/COMODORSAAddTrustCA.crt'] ssl ca chain (only need when you set usessl)
dhparampath ./cert/dhparam.pem ssl dhparam path (only need when you set usessl)
tmppath ./tmp/ temp directory path
defaultnotepath ./public/default.md default note file path
docspath ./public/docs docs directory path
indexpath ./public/views/index.ejs index template file path
hackmdpath ./public/views/hackmd.ejs hackmd template file path
errorpath ./public/views/error.ejs error template file path
prettypath ./public/views/pretty.ejs pretty template file path
slidepath ./public/views/slide.hbs slide template file path
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
allowemailregister true or false set to allow email register (only applied when email is set, default is true)
imageUploadType imgur(default), s3 or filesystem Where to upload image
s3 { "accessKeyId": "YOUR_S3_ACCESS_KEY_ID", "secretAccessKey": "YOUR_S3_ACCESS_KEY", "region": "YOUR_S3_REGION", "bucket": "YOUR_S3_BUCKET_NAME" } When imageUploadType be setted to s3, you would also need to setup this key, check our S3 Image Upload Guide

Third-party integration api key settings

service settings location description
facebook, twitter, github, gitlab, dropbox, google, ldap environment variables or config.json for signin
imgur environment variables or config.json for image upload
google drive(google/apiKey, google/clientID), dropbox(dropbox/appKey) config.json for export and import

Third-party integration oauth callback urls

service callback url (after the server url)
facebook /auth/facebook/callback
twitter /auth/twitter/callback
github /auth/github/callback
gitlab /auth/gitlab/callback
dropbox /auth/dropbox/callback
google /auth/google/callback

Operational Transformation

From 0.3.2, we started supporting operational transformation.
It makes concurrent editing safe and will not break up other users' operations.
Additionally, now can show other clients' selections.
See more at http://operational-transformation.github.io/

License under MIT.