summaryrefslogtreecommitdiff
path: root/README.md (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Update badge iconsSheogorath2019-08-031-2/+2
| | | | | | | | I just noticed that shields.io provides some nice new badges including one explicitly for Matrix and one for Mastodon. Since those are really our platforms, let's get them into our README. Just a cosmetic change. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Fix some minor quirks in the LinuxServer.io docsSheogorath2019-08-011-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The current documents might end up confusing people and are not completely accessible. This minor fixes should clear up the situation and add alt texts to all badges, explain the links at the end of the docs, and list LinuxServer.io in the supported provider section of the README. Some reasoning on the change in the listing: Since we maintain an own container image which is for sure kept updated on release, this is our first listing, as well as general solutions that are build on that image, like the K8s integration. The next listings are integrated provides which allow self-hosting, like Cloudron and I also consider LinuxServer.io as this kind of providers. Which try to enable people to run CodiMD on their own hardware or rented servers in a very easy way, but by using their own images. As third category I would look at hosted offers, like Heroku, which are not completely SaaS but far enough away from the self-hostability that I consider them as an own category. PaaS-based solutions are not as FOSS-style as we want our setups to be, but of course still supported. Finally the manual setup. We keep it down here, because we support it, but don't recommend it in general. It's hard to upgrade and can cause problems when dependencies are not correctly updated or people don't run the db migrations. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add docker image from LinuxServer.io as an install option.chbmb2019-06-121-1/+2
| | | | | As requested by @SISheogorath [here](https://github.com/linuxserver/docker-codimd/issues/4#issue-454332233) and further to discussion about previous PR [here.](https://github.com/codimd/server/pull/110#issuecomment-501214087) Signed-off-by: Neil Green <chbmb@linuxserver.io>
* add mastodon badge - partially fix #70Amolith2019-05-191-0/+3
| | | | Signed-off-by: Amolith <amolith@nixnet.xyz>
* tiny correction to url. also adding RSS feed.Claudius Coenen2019-04-041-2/+2
|
* Update community call URLSheogorath2019-04-031-1/+1
| | | | | | | | | | We have a discourse forum and since it's the place for all kinds of community organisation, this should be used for organising the community calls. This patch updates the link to the new topic in the forum. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* more ways to engage with the community added to the readmeClaudius2019-04-031-7/+20
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* striving for consistency across various docsClaudius2019-04-011-3/+5
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* splitting README.md into files in /docs for better readabilityClaudius2019-04-011-340/+41
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* Add note about changing the upstream repositorySheogorath2019-03-281-0/+2
| | | | | | | | People who want to get the latest and greatest version of CodiMD should be aware of the repository change. This upgrade note, will hopefully help. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Fix container image linksSheogorath2019-03-281-2/+2
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Fix some remaining references to the old repositorySheogorath2019-03-281-3/+3
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Update links to new repositoriesSheogorath2019-03-271-8/+8
| | | | | | | | | | | | After a long discussion, it turned out that CodiMD as community project and HackMD as a company, have fundamental different views on the project governance. Due to this, it came to point where the decision for a fork was made. After the fork and move towards an own organisation, this patch updates all links inside the project to the new repositories. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Mention dependency on libssl-dev in README.mdTurakar2019-03-041-0/+1
| | | | | | This dependency was introduced by upgrading to the new scrypt version in commit cee2aa92f9244d1dcfc65c5553f5d7f0bbfb3871. Signed-off-by: Tilman Hoffbauer <turakar23@gmail.com>
* Fix reference to SAML guide in READMEJonathan2019-01-221-1/+1
| | | | Signed-off-by: Jonathan Klauck <jonathan.klauck@aoe.com>
* Add hints about how to be informed about updatesSheogorath2018-11-181-0/+4
| | | | | | | | | | | | Keeping people in the loop about new version of CodiMD is not easy. When people don't keep an eye on GitHub it's easy to miss new versions. To help people keeping their software up to date, this patch adds hints to check out our community channel or simply the GitHub Atom feed generated for based on the release page to get informed about new versions. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Merge pull request #1053 from dsprenkels/robots.txtChristoph (Sheogorath) Kern2018-11-171-0/+2
|\ | | | | Disallow creation of robots.txt in freeurl
| * Disallow creation of robots.txt in freeurlDaan Sprenkels2018-11-171-0/+2
| | | | | | | | | | | | | | | | | | | | | | Add a configuration setting to "hard"-disable creation of notes as set by the configuration value. This defaults to `['robots.txt', 'favicon.ico']`, because these files are often accidentally created by bots and browsers. This commit fixes #1052. Signed-off-by: Daan Sprenkels <hello@dsprenkels.com>
* | switching to eslint for code checkingClaudius Coenen2018-11-141-4/+0
| | | | | | | | | | | | | | most rules degraded to WARN, so we don't go insane. This will change over time. The aim is to conform to a common style Signed-off-by: Claudius Coenen <opensource@amenthes.de>
* | Upgrade winstonSheogorath2018-11-141-0/+2
|/ | | | | | | | | Our log library got a new major version which should be implemented. That's exactly what this patch does. Implementing the new version of the logging library. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add full version stringSheogorath2018-11-111-0/+2
| | | | | | | | | | | | Currently we only provide the version from `package.json`. This means that during updates of instances, e.g. the demo instance, which runs latest master instead of a stable release, changes are not reflected to the webclient. This patch adds a fullversion string that contains the current commit and this way makes that clients are notified about changes. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Remove Gitter from codebaseSheogorath2018-10-171-3/+0
| | | | | | | | | | We no longer use Gitter for development talk and similar. So we might want to remove it? This patch removes Gitter from README, help page and features page. And replaces it in the help modal with POEditor, our translation platform. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Merge pull request #990 from SISheogorath/fix/oauthProviderNameChristoph (Sheogorath) Kern2018-10-091-0/+1
|\ | | | | Make oauth2 provider name accessible
| * Make oauth2 provider name accessibleSheogorath2018-10-041-0/+1
| | | | | | | | | | | | | | | | | | Right now the feature exists but is almost not usable since the only way to configure it is to know that it exists from reading the source code and add it to config.json. This patch provides all needed changes so it can be used by everyone including documentation. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* | Update supported node.js versionXaver Maierhofer2018-10-071-1/+1
| | | | | | | | | | | | Support includes v9.x, but no v10.x Signed-off-by: Xaver Maierhofer <xaver.maierhofer@xwissen.info>
* | Merge pull request #940 from WilliButz/fix-configurable-pathsChristoph (Sheogorath) Kern2018-10-051-13/+12
|\ \ | |/ |/| enhance configurabiltiy of paths & make execution path-independent
| * README: add note about configurable pathsWilliButz2018-09-271-13/+12
| | | | | | | | Signed-off-by: WilliButz <wbutz@cyberfnord.de>
* | details about OAuth2 in general. Fixes #930Claudius Coenen2018-10-041-0/+9
|/ | | | Signed-off-by: Claudius Coenen <opensource@amenthes.de>
* Remove dead link from READMESheogorath2018-09-121-3/+0
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Fix typo in linkSheogorath2018-09-061-1/+1
|
* Change to new codimd-container repositorySheogorath2018-09-061-4/+4
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add an auth provider guide for MattermostOndřej Slabý2018-08-281-1/+1
| | | | Signed-off-by: Ondřej Slabý <kron258@gmail.com>
* Add Cloudron as an installation methodGirish Ramakrishnan2018-08-201-0/+7
| | | | | | Fixes #923 Signed-off-by: Girish Ramakrishnan <girish@cloudron.io>
* Add possibility to choose between version v3 or v4 for the gitlab api.Cédric Couralet2018-07-311-0/+1
| | | | | | | | Apart from the uri versioning, one big change is the snippet visibility post data (visibility_level -> visibility) Default gitlab api version to v4 Signed-off-by: Cédric Couralet <cedric.couralet@gmail.com>
* Support 'host' & 'path' config optionsMiranda Kastemaa2018-07-271-0/+4
| | | | Signed-off-by: Miranda Kastemaa <miranda@foldplop.com>
* Update install instructions to cover sequelizeSheogorath2018-06-261-1/+4
| | | | | | | We instruct people to run db migrations on inital setup. We should do that! Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Rename environment variables and add legacy support.Sheogorath2018-06-241-74/+76
| | | | | | | | As we are no longer HackMD the short tag `HMD` doesn't match anymore. We move it to the matching prefix `CMD` and inform our users about the change. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add background story about the renamingSheogorath2018-06-241-0/+11
| | | | | | | | We want to communicate transparent. So we should state very clear what CodiMD is and what makes it different from HackMD and at the same time how we are related and that there are no bad boys involved. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Rebrand HackMD to CodiMDSheogorath2018-06-241-33/+33
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Allow to disable gravatarSheogorath2018-06-231-0/+2
| | | | | | | | | Since Gravatar is an external image source and not perfect from a privacy perspective, forbidding it allows to improve privacy. This commit also simplifies and optimizes the avatar code. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Fix possible error if HackMD is started with wrong workdirSheogorath2018-06-231-0/+1
| | | | | | | | | | In https://github.com/hackmdio/hackmd/issues/834 is described how starting HackMD crashes when using the wrong working dir. This is caused by a relative path in our upload routine. This change should fix it and prevent future crashes. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Merge pull request #844 from hackmdio/docs/fix-defaultChristoph (Sheogorath) Kern2018-06-181-2/+2
|\ | | | | Fix wrong docs about default image upload location
| * Fix wrong docs about default image upload locationSheogorath2018-06-171-2/+2
| | | | | | | | | | | | | | | | We wrongly state that the default image upload location is imgur. This is no longer true, but got lost when updating docs. This commit should fix it. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* | Add K8s note in READMESheogorath2018-06-171-0/+7
|/ | | | | | | We have an official K8s chart for helm out there but probably no one knows about it. Let's advertise it a bit! Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add Azure Blob Storage supportÁdám Hóka2018-06-011-2/+4
| | | | Signed-off-by: Adam Hoka <hoka.adam@nexogen.hu>
* Removing google drive integrationSheogorath2018-05-161-1/+1
| | | | | | | | | | | | | | | It's sad but it's not working. For multiple releases this should be already broken which shows how often it's used. As there is also a security issue related to that, it's better to remove the feature completely. Whoever wants to rewrite it, feel free to go. This commit removes the Google Drive integration from HackMD's Frontend editor and this way removes the need to provide any API key and Client ID in the frontend. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Fix possible file limit errorsSheogorath2018-04-161-2/+1
| | | | | | | | | | | | | | | As we currently may need higher nofile limits than usual/default on various systems this commit should probide a fix for that an allow to build HackMD without highering these limits and increase security. Inspiration was found in a copy-webpack-plugin-issue[1] and found by @thegcat[2]. Thanks for that! Signed-off-by: Sheogorath <sheogorath@shivering-isles.com> [1]: https://github.com/webpack-contrib/copy-webpack-plugin/issues/59#issuecomment-228563990 [2]: https://github.com/thegcat
* Extend READMESheogorath2018-04-111-0/+4
| | | | | | | Add hint about file descriptor limits and add the new translation platform. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Merge branch 'feature/releaseNotes1.1.0'Sheogorath2018-04-061-2/+9
|\
| * Add migration section to README.mdSheogorath2018-04-061-2/+9
| | | | | | | | | | | | | | As it was requested to be more visable, this commit adds a migration section about the introduced config style changes. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-02 19:14:28 +0000