diff options
-rw-r--r-- | README.md | 28 | ||||
-rw-r--r-- | app.json | 4 | ||||
-rwxr-xr-x | bin/setup | 2 | ||||
-rw-r--r-- | docs/guides/migrate-etherpad.md | 10 | ||||
-rw-r--r-- | docs/guides/s3-image-upload.md | 2 | ||||
-rw-r--r-- | lib/config/index.js | 2 | ||||
-rw-r--r-- | package.json | 13 | ||||
-rw-r--r-- | public/css/index.css | 2 | ||||
-rw-r--r-- | public/docs/features.md | 2 | ||||
-rw-r--r-- | public/docs/release-notes.md | 14 | ||||
-rw-r--r-- | public/views/index/body.ejs | 2 | ||||
-rw-r--r-- | public/views/shared/help-modal.ejs | 2 |
12 files changed, 48 insertions, 35 deletions
@@ -89,7 +89,7 @@ To stay up to date with your installation it's recommended to join our [Matrix c You can quickly setup a sample Heroku CodiMD application by clicking the button below. -[](https://heroku.com/deploy?template=https://github.com/hackmdio/codimd/tree/master) +[](https://heroku.com/deploy?template=https://github.com/codimd/server/tree/master) If you deploy it without the button, keep in mind to use the right buildpacks. For details check `app.json`. @@ -100,26 +100,26 @@ To install use `helm install stable/hackmd`. For all further details, please check out the offical CodiMD [K8s helm chart](https://github.com/kubernetes/charts/tree/master/stable/hackmd). ## CodiMD by docker container -[](http://play-with-docker.com?stack=https://github.com/hackmdio/codimd-container/raw/master/docker-compose.yml&stack_name=codimd) +[](http://play-with-docker.com?stack=https://github.com/codimd/container/raw/master/docker-compose.yml&stack_name=codimd) **Debian-based version:** -[](https://microbadger.com/images/hackmdio/hackmd "Get your own version badge on microbadger.com") [](https://microbadger.com/images/hackmdio/hackmd "Get your own image badge on microbadger.com") +[](https://quay.io/repository/codimd/server) **Alpine-based version:** -[](https://microbadger.com/images/hackmdio/hackmd:alpine "Get your own version badge on microbadger.com") [](https://microbadger.com/images/hackmdio/hackmd:alpine "Get your own image badge on microbadger.com") +[](https://quay.io/repository/codimd/server) The easiest way to setup CodiMD using docker are using the following three commands: ```console -git clone https://github.com/hackmdio/codimd-container.git +git clone https://github.com/codimd/container.git cd codimd-container docker-compose up ``` -Read more about it in the [container repository…](https://github.com/hackmdio/codimd-container) +Read more about it in the [container repository…](https://github.com/codimd/container) ## Cloudron @@ -131,6 +131,8 @@ Install CodiMD on [Cloudron](https://cloudron.io): ## Native setup +:warning: When you are still running from the old repository, please run: `git remote set-url origin https://github.com/codimd/server.git` :warning: + If you are upgrading CodiMD from an older version, follow these steps: 1. Fully stop your old server first (important) @@ -264,7 +266,7 @@ There are some config settings you need to change in the files below. | `CMD_HSTS_PRELOAD` | `true` | whether to allow preloading of the site's HSTS status (e.g. into browsers) | | `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 | -| `CMD_SOURCE_URL` | `https://github.com/hackmdio/codimd/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) | +| `CMD_SOURCE_URL` | `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) | ***Note:** Due to the rename process we renamed all `HMD_`-prefix variables to be `CMD_`-prefixed. The old ones continue to work.* @@ -317,7 +319,7 @@ There are some config settings you need to change in the files below. | `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](docs/guides/minio-image-upload.md) | | `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](docs/guides/s3-image-upload.md) | | `s3bucket` | `YOUR_S3_BUCKET_NAME` | bucket name when `imageUploadType` is set to `s3` or `minio` | -| `sourceURL` | `https://github.com/hackmdio/codimd/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) | +| `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) | <sup>1</sup>: relative paths are based on CodiMD's base directory @@ -373,10 +375,10 @@ See more at [http://operational-transformation.github.io/](http://operational-tr [matrix.org-image]: https://img.shields.io/badge/Matrix.org-%23CodiMD@matrix.org-green.svg [matrix.org-url]: https://riot.im/app/#/room/#codimd:matrix.org -[travis-image]: https://travis-ci.org/hackmdio/codimd.svg?branch=master -[travis-url]: https://travis-ci.org/hackmdio/codimd -[github-version-badge]: https://img.shields.io/github/release/hackmdio/codimd.svg -[github-release-page]: https://github.com/hackmdio/codimd/releases -[github-release-feed]: https://github.com/hackmdio/codimd/releases.atom +[travis-image]: https://travis-ci.org/codimd/server.svg?branch=master +[travis-url]: https://travis-ci.org/codimd/server +[github-version-badge]: https://img.shields.io/github/release/codimd/server.svg +[github-release-page]: https://github.com/codimd/server/releases +[github-release-feed]: https://github.com/codimd/server/releases.atom [poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg [poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir @@ -7,8 +7,8 @@ "Notes" ], "website": "https://codimd.org", - "repository": "https://github.com/hackmdio/codimd", - "logo": "https://github.com/hackmdio/codimd/raw/master/public/codimd-icon-1024.png", + "repository": "https://github.com/codimd/server", + "logo": "https://github.com/codimd/server/raw/master/public/codimd-icon-1024.png", "success_url": "/", "env": { "BUILD_ASSETS": { @@ -36,7 +36,7 @@ cat << EOF Edit the following config file to setup CodiMD server and client. -Read more info at https://github.com/hackmdio/codimd#configuration-files +Read more info at https://github.com/codimd/server#configuration-files * config.json -- CodiMD config * .sequelizerc -- db config diff --git a/docs/guides/migrate-etherpad.md b/docs/guides/migrate-etherpad.md index c3783c89..914a240d 100644 --- a/docs/guides/migrate-etherpad.md +++ b/docs/guides/migrate-etherpad.md @@ -12,7 +12,7 @@ require some creativity to work properly in your case. When I wrote this guide, [Etherpad 1.7.0] and [CodiMD 1.2.1]. Good luck! [Etherpad 1.7.0]: https://github.com/ether/etherpad-lite/tree/1.7.0 -[CodiMD 1.2.1]: https://github.com/hackmdio/codimd/tree/1.2.1 +[CodiMD 1.2.1]: https://github.com/codimd/server/tree/1.2.1 ## 0. Requirements @@ -21,7 +21,7 @@ require some creativity to work properly in your case. When I wrote this guide, - running CodiMD server - [codimd-cli] -[codimd-cli]: https://github.com/hackmdio/codimd-cli/blob/master/bin/codimd +[codimd-cli]: https://github.com/codimd/cli/blob/master/bin/codimd ## 1. Retrieve the list of pads @@ -56,8 +56,8 @@ configuration settings `ETHERPAD_SERVER` and `CODIMD_SERVER`. # Description: Migrate pads from etherpad to codimd # Author: Daan Sprenkels <hello@dsprenkels.com> -# This script uses the codimd command line script[1] to import a list of pads from -# [1]: https://github.com/hackmdio/codimd-cli/blob/master/bin/codimd +# This script uses the codimd command line script[1] to import a list of pads from +# [1]: https://github.com/codimd/cli/blob/master/bin/codimd # The base url to where etherpad is hosted ETHERPAD_SERVER="https://etherpad.example.com" @@ -80,7 +80,7 @@ for PAD_NAME in $1; do # Download the pad PAD_FILE="$(mktemp)" curl "$ETHERPAD_SERVER/p/$PAD_NAME/export/txt" >"$PAD_FILE" - + # Import the pad into codimd OUTPUT="$(./codimd import "$PAD_FILE")" echo "$PAD_NAME -> $OUTPUT" >>"$REDIRECTS_FILE" diff --git a/docs/guides/s3-image-upload.md b/docs/guides/s3-image-upload.md index dc5e420d..40ab868a 100644 --- a/docs/guides/s3-image-upload.md +++ b/docs/guides/s3-image-upload.md @@ -76,7 +76,7 @@ } ``` -9. In additional to edit `config.json` directly, you could also try [environment variable](https://github.com/hackmdio/hackmd#environment-variables-will-overwrite-other-server-configs). +9. In additional to edit `config.json` directly, you could also try [environment variable](https://github.com/codimd/server#environment-variables-will-overwrite-other-server-configs). ## Related Tools diff --git a/lib/config/index.js b/lib/config/index.js index e5d02dc1..4c28196e 100644 --- a/lib/config/index.js +++ b/lib/config/index.js @@ -152,7 +152,7 @@ for (let i = keys.length; i--;) { // Notify users about the prefix change and inform them they use legacy prefix for environment variables if (Object.keys(process.env).toString().indexOf('HMD_') !== -1) { - logger.warn('Using legacy HMD prefix for environment variables. Please change your variables in future. For details see: https://github.com/hackmdio/codimd#environment-variables-will-overwrite-other-server-configs') + logger.warn('Using legacy HMD prefix for environment variables. Please change your variables in future. For details see: https://github.com/codimd/server#environment-variables-will-overwrite-other-server-configs') } // Generate session secret if it stays on default values diff --git a/package.json b/package.json index a3da0ba7..538a320f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "CodiMD", - "version": "1.3.1", + "version": "1.3.2", "description": "Realtime collaborative markdown notes on all platforms.", "main": "app.js", "license": "AGPL-3.0", @@ -140,7 +140,7 @@ "engines": { "node": ">=6.x" }, - "bugs": "https://github.com/hackmdio/codimd/issues", + "bugs": "https://github.com/codimd/server/issues", "keywords": [ "Collaborative", "Markdown", @@ -149,17 +149,18 @@ "homepage": "https://codimd.org", "maintainers": [ { - "name": "Max Wu", - "email": "jackymaxj@gmail.com" + "name": "Claudius Coenen", + "url": "https://www.claudiuscoenen.de/" }, { "name": "Christoph (Sheogorath) Kern", - "email": "codimd@sheogorath.shivering-isles.com" + "email": "codimd@sheogorath.shivering-isles.com", + "url": "https://shivering-isles.com" } ], "repository": { "type": "git", - "url": "https://github.com/hackmdio/codimd.git" + "url": "https://github.com/codimd/server.git" }, "devDependencies": { "babel-cli": "^6.26.0", diff --git a/public/css/index.css b/public/css/index.css index d9ebf6de..c304a969 100644 --- a/public/css/index.css +++ b/public/css/index.css @@ -385,7 +385,7 @@ div[contenteditable]:empty:not(:focus):before{ color: #eee; } -.night .btn.btn-default.ui-view.active{ +.night .btn.btn-default.active{ background: #202020; } diff --git a/public/docs/features.md b/public/docs/features.md index e7ce89ce..e17619fb 100644 --- a/public/docs/features.md +++ b/public/docs/features.md @@ -7,7 +7,7 @@ Introduction This means that you can write notes with other people on your **desktop**, **tablet** or even on the **phone**. You can sign-in via multiple auth providers like **Facebook**, **Twitter**, **GitHub** and many more on the [_homepage_](/). -If you experience any _issues_, feel free to report it on [**GitHub**](https://github.com/hackmdio/codimd/issues). +If you experience any _issues_, feel free to report it on [**GitHub**](https://github.com/codimd/server/issues). Or meet us on [**Matrix.org**](https://riot.im/app/#/room/#codimd:matrix.org) for dev-talk and interactive help. **Thank you very much!** diff --git a/public/docs/release-notes.md b/public/docs/release-notes.md index 1addf546..6c30a0ff 100644 --- a/public/docs/release-notes.md +++ b/public/docs/release-notes.md @@ -1,6 +1,16 @@ Release Notes === +<i class="fa fa-tag"></i> 1.3.2 <i class="fa fa-clock-o"></i> 2019-03-28 00:00 +--- + +### Announcement +* CodiMD is now running in an own organization. [Check out our vision for the future](https://github.com/codimd/server/issues/10) + +### Fixes +* Update various links to the new repositories +* Fix background color for mode switching button in night mode + <i class="fa fa-tag"></i> 1.3.1 <i class="fa fa-clock-o"></i> 2019-03-23 00:00 --- @@ -158,7 +168,7 @@ Release Notes ### Deprecations * NodeJS version 6 -* Mattermost login integration (is replaced by [generic oAuth2 module](https://github.com/hackmdio/codimd/blob/6ce7b20a7f92ccff2f7f870ff5d116d685310cfd/docs/guides/auth/mattermost-self-hosted.md)) +* Mattermost login integration (is replaced by [generic oAuth2 module](https://github.com/codimd/server/blob/6ce7b20a7f92ccff2f7f870ff5d116d685310cfd/docs/guides/auth/mattermost-self-hosted.md)) ### Honorable mentions * [Alex Hesse (Pingu501)](https://github.com/Pingu501) @@ -174,7 +184,7 @@ Release Notes --- ### Announcement -* HackMD CE is renamed to CodiMD to prevent confusion. [For details see here](https://github.com/hackmdio/codimd#hackmd-ce-became-codimd) +* HackMD CE is renamed to CodiMD to prevent confusion. [For details see here](https://github.com/codimd/server#hackmd-ce-became-codimd) ### Enhancements * Show full title by hovering over to table of contents entries diff --git a/public/views/index/body.ejs b/public/views/index/body.ejs index 9b871f83..db22f2e3 100644 --- a/public/views/index/body.ejs +++ b/public/views/index/body.ejs @@ -154,7 +154,7 @@ <%- __('Powered by %s', '<a href="https://codimd.org">CodiMD</a>') %> | <a href="<%- serverURL %>/s/release-notes" target="_blank" rel="noopener"><%= __('Releases') %></a>| <a href="<%- sourceURL %>" target="_blank" rel="noopener"><%= __('Source Code') %></a><% if(privacyStatement) { %> | <a href="<%- serverURL %>/s/privacy" target="_blank" rel="noopener"><%= __('Privacy') %></a><% } %><% if(termsOfUse) { %> | <a href="<%- serverURL %>/s/terms-of-use" target="_blank" rel="noopener"><%= __('Terms of Use') %></a><% } %> </p> <h6 class="social-foot"> - <%- __('Follow us on %s and %s.', '<a href="https://github.com/hackmdio/CodiMD" target="_blank" rel="noopener"><i class="fa fa-github"></i> GitHub</a>, <a href="https://riot.im/app/#/room/#codimd:matrix.org" target="_blank" rel="noopener"><i class="fa fa-comments"></i> Riot</a>', '<a href="https://translate.codimd.org" target="_blank" rel="noopener"><i class="fa fa-globe"></i> POEditor</a>') %> + <%- __('Follow us on %s and %s.', '<a href="https://github.com/codimd/server" target="_blank" rel="noopener"><i class="fa fa-github"></i> GitHub</a>, <a href="https://riot.im/app/#/room/#codimd:matrix.org" target="_blank" rel="noopener"><i class="fa fa-comments"></i> Riot</a>', '<a href="https://translate.codimd.org" target="_blank" rel="noopener"><i class="fa fa-globe"></i> POEditor</a>') %> </h6> </div> </div> diff --git a/public/views/shared/help-modal.ejs b/public/views/shared/help-modal.ejs index ec35b0e9..ab9f6b70 100644 --- a/public/views/shared/help-modal.ejs +++ b/public/views/shared/help-modal.ejs @@ -15,7 +15,7 @@ <h3 class="panel-title"><%= __('Contacts') %></h3> </div> <div class="panel-body"> - <a href="https://github.com/hackmdio/codimd/issues" target="_blank"><i class="fa fa-tag fa-fw"></i> <%= __('Report an issue') %></a> + <a href="https://github.com/codimd/server/issues" target="_blank"><i class="fa fa-tag fa-fw"></i> <%= __('Report an issue') %></a> <br> <a href="https://riot.im/app/#/room/#codimd:matrix.org" target="_blank"><i class="fa fa-hashtag fa-fw"></i> <%= __('Meet us on %s', 'Matrix') %></a> <br> |