summaryrefslogtreecommitdiff
path: root/README.md (unfollow)
Commit message (Collapse)AuthorFilesLines
2019-03-04Mention dependency on libssl-dev in README.mdTurakar1-0/+1
This dependency was introduced by upgrading to the new scrypt version in commit cee2aa92f9244d1dcfc65c5553f5d7f0bbfb3871. Signed-off-by: Tilman Hoffbauer <turakar23@gmail.com>
2019-01-22Fix reference to SAML guide in READMEJonathan1-1/+1
Signed-off-by: Jonathan Klauck <jonathan.klauck@aoe.com>
2018-11-18Add hints about how to be informed about updatesSheogorath1-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>
2018-11-17Disallow creation of robots.txt in freeurlDaan Sprenkels1-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>
2018-11-14switching to eslint for code checkingClaudius Coenen1-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>
2018-11-14Upgrade winstonSheogorath1-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>
2018-11-11Add full version stringSheogorath1-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>
2018-10-17Remove Gitter from codebaseSheogorath1-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>
2018-10-07Update supported node.js versionXaver Maierhofer1-1/+1
Support includes v9.x, but no v10.x Signed-off-by: Xaver Maierhofer <xaver.maierhofer@xwissen.info>
2018-10-04Make oauth2 provider name accessibleSheogorath1-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>
2018-10-04details about OAuth2 in general. Fixes #930Claudius Coenen1-0/+9
Signed-off-by: Claudius Coenen <opensource@amenthes.de>
2018-09-27README: add note about configurable pathsWilliButz1-13/+12
Signed-off-by: WilliButz <wbutz@cyberfnord.de>
2018-09-12Remove dead link from READMESheogorath1-3/+0
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-09-06Fix typo in linkSheogorath1-1/+1
2018-09-06Change to new codimd-container repositorySheogorath1-4/+4
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-08-28Add an auth provider guide for MattermostOndřej Slabý1-1/+1
Signed-off-by: Ondřej Slabý <kron258@gmail.com>
2018-08-20Add Cloudron as an installation methodGirish Ramakrishnan1-0/+7
Fixes #923 Signed-off-by: Girish Ramakrishnan <girish@cloudron.io>
2018-07-31Add possibility to choose between version v3 or v4 for the gitlab api.Cédric Couralet1-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>
2018-07-27Support 'host' & 'path' config optionsMiranda Kastemaa1-0/+4
Signed-off-by: Miranda Kastemaa <miranda@foldplop.com>
2018-06-26Update install instructions to cover sequelizeSheogorath1-1/+4
We instruct people to run db migrations on inital setup. We should do that! Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-06-24Rename environment variables and add legacy support.Sheogorath1-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>
2018-06-24Add background story about the renamingSheogorath1-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>
2018-06-24Rebrand HackMD to CodiMDSheogorath1-33/+33
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-06-23Allow to disable gravatarSheogorath1-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>
2018-06-23Fix possible error if HackMD is started with wrong workdirSheogorath1-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>
2018-06-17Fix wrong docs about default image upload locationSheogorath1-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>
2018-06-17Add K8s note in READMESheogorath1-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>
2018-06-01Add Azure Blob Storage supportÁdám Hóka1-2/+4
Signed-off-by: Adam Hoka <hoka.adam@nexogen.hu>
2018-05-16Removing google drive integrationSheogorath1-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>
2018-04-16Fix possible file limit errorsSheogorath1-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
2018-04-11Extend READMESheogorath1-0/+4
Add hint about file descriptor limits and add the new translation platform. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-04-06Add migration section to README.mdSheogorath1-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>
2018-03-29Add session data to env varsSheogorath1-0/+2
Currently the session secret can only be set by config.json or docker secrets. This creates a problem on Heroku hosted instances that can not set a session secret. Since we automatically generate them on startup this results in an logout of all users on every config change in Heroku. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-03-25Change config to camel case with backwards compatibilitySheogorath1-36/+36
This refactors the configs a bit to now use camel case everywhere. This change should help to clean up the config interface and make it better understandable. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-03-14Add config option for report URI in CSPSheogorath1-0/+1
This option is needed as it's currently not possible to add an report URI by the directives array. This option also allows to get CSP reports not only on docker based setup but also on our heroku instances. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-03-05Remove unused LDAP option `tokenSecret`Felix Schäfer1-1/+0
hackmdio/hackmd#754 Signed-off-by: Felix Schäfer <felix@thegcat.net>
2018-03-01Introduce ldap.useridFieldDustin Frisch1-1/+2
Signed-off-by: Dustin Frisch <fooker@lab.sh>
2018-02-17Rerun doctocZearin1-2/+2
Signed-off-by: Anthony "Zearin" Rogers <zearin@users.sourceforge.net>
2018-02-17Update README.mdZearin1-117/+117
Signed-off-by: Anthony "Zearin" Rogers <zearin@users.sourceforge.net>
2018-02-08Add matrix.org badge to README.mdChristoph (Sheogorath) Kern1-0/+3
Matrix.org is an interesting platform for collaboration and community building. Thanks to various clients it supports it's maybe better than gitter to keep people on track and have a community feeling, discuss changes and more. Not not split up into two parties not knowing of each other, the Gitter channel and the Matrix channel are bridged. This helps to keep everyone informed while add more medias. Signed-off-by: Christoph Kern <sheogorath@shivering-isles.com>
2018-01-31Update Heroku buttonSheogorath1-2/+4
The button needs a parameter to work, that provides the git repository that is used for the deployment. This commit corrects the link and this way fixes the provisioning as it's not working with the wrong/default buildpacks. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-01-29Update badges in README.mdSheogorath1-2/+2
The docker badges have to be updated since we now provide official image like tags. So `latest-alpine` became `alpine`. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-01-29Add simple user-management tool for emailsignin …Dario Ernst1-2/+2
Currently, administrators of closed instances need to manually fiddle in their databases for user-management. This commit adds a small commandline utility that allows to create and delete users. Signed-off-by: Dario Ernst <dario@kanojo.de>
2018-01-27Remove camel case from `imageuploadtype` in configSheogorath1-4/+4
This removes the only camel cased option of the config options **we** added to the config.json. In auth provider's config parts are a lot of camel cased options provided. We shouldn't touch them to keep them as similar as possible to the examples. Fixes #315 Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-01-26Add recommendation for 2GB RAMSheogorath1-0/+1
We noticed on multiple places that machines with less than 2GB of RAM fail their build and result in missing files and unexpected errors. Sadly we can't really solve this right now since it's a webpack related bug. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-01-26Extend README changes for minioSheogorath1-3/+3
2018-01-23Add README and `config.json.example` contentSheogorath1-1/+7
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-01-20Add option to enable `freely` permission in closed instanceDario Ernst1-0/+2
Before, closed disallowed guest edits completely, by removing the `freely` permission. This makes it possible to explicitely bring back guest-editing, but not guest-note-creation, to closed instances. Signed-off-by: Dario Ernst <dario@kanojo.de>
2018-01-18Update README.mdMax Wu1-1/+1
To show "Community Edition" on title.
2018-01-03[ci skip] Add CodeTriage badgeschneems1-1/+3
[CodeTriage](https://www.codetriage.com/) is an app I have maintained for the past 4-5 years with the goal of getting people involved in Open Source projects like this one. The app sends subscribers a random open issue for them to help "triage". For some languages you can also suggested areas to add documentation. The initial approach was inspired by seeing the work of the small core team spending countless hours asking "what version was this in" and "can you give us an example app". The idea is to outsource these small interactions to a huge team of volunteers and let the core team focus on their work. I want to add a badge to the README of this project. The idea is to provide an easy link for people to get started contributing to this project. A badge indicates the number of people currently subscribed to help the repo. The color is based off of open issues in the project. Here are some examples of other projects that have a badge in their README: - https://github.com/crystal-lang/crystal - https://github.com/rails/rails - https://github.com/codetriage/codetriage Thanks for building open source software, I would love to help you find some helpers.
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-29 14:14:25 +0000