summaryrefslogtreecommitdiff
path: root/docs/setup (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Move docs into subdirectory to make mkdocs work in a subdirectoryTilman Vatteroth2021-01-058-209/+0
| | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* Merge pull request #646 from hedgedoc/kubernetesDavid Mehren2021-01-041-2/+2
|\
| * remove old documentationPhilip Molares2021-01-031-4/+0
| | | | | | | | Signed-off-by: Philip Molares <philip.molares@udo.edu>
| * Update docs/setup/kubernetes.mdPhilip Molares2021-01-021-1/+1
| | | | | | | | | | Co-authored-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Signed-off-by: Philip Molares <philip.molares@udo.edu>
| * changed kubernetes setup docPhilip Molares2021-01-021-2/+6
| | | | | | | | | | | | | | currently we don't provide our own and still linking to hackmd/codimd is not helpful Signed-off-by: Philip Molares <philip.molares@udo.edu>
* | update linuxserver docker infoaptalca2020-12-241-4/+12
|/ | | | | | Update badges and info to point to the newly published HedgeDoc image Signed-off-by: aptalca <aptalca@linuxserver.io>
* Set Install-with-yunohost bagde to SVGericgaspar2020-12-211-1/+1
| | | | Signed-off-by: ericgaspar <junk.eg@free.fr>
* Fix typo in reverse proxy docsDavid Mehren2020-12-131-1/+1
| | | | Signed-off-by: David Mehren <git@herrmehren.de>
* Document reverse proxy config for ApacheDavid Mehren2020-12-131-0/+26
| | | | | | As we found out in #616, Apache does not set the `X-Forwarded-Proto` header, which is now required because we switched to secure cookies in 383d791a50919bb9890a3f3f797ecc95125ab8bf. Signed-off-by: David Mehren <git@herrmehren.de>
* Update yunohost.mdericgaspar2020-11-301-2/+2
| | | | | | | | Signed-off-by: ericgaspar <junk.eg@free.fr> Upgrade YunoHost doc link Signed-off-by: ericgaspar <junk.eg@free.fr>
* Merge pull request #597 from hedgedoc/fix/install-docsDavid Mehren2020-11-291-23/+14
|\
| * Document that Git can also be used to checkout releases.David Mehren2020-11-271-1/+2
| | | | | | | | Signed-off-by: David Mehren <git@herrmehren.de>
| * Mention that the database connection string needs an absolute path to the ↵David Mehren2020-11-271-1/+1
| | | | | | | | | | | | SQLite file Signed-off-by: David Mehren <git@herrmehren.de>
| * Update manual install docs for 1.7David Mehren2020-11-271-22/+12
| | | | | | | | | | | | | | Starting with 1.7, releases include the frontend bundle. This commit updates the docs accordingly. Signed-off-by: David Mehren <git@herrmehren.de>
* | Remove pdf export codeTilman Vatteroth2020-11-261-1/+1
|/ | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* Replace nGinx by NginxNils VAN ZUIJLEN2020-11-181-2/+2
| | | | Signed-off-by: Nils VAN ZUIJLEN <nils.van-zuijlen@mailo.com>
* Add documentation for reverse-proxy useNils VAN ZUIJLEN2020-11-181-0/+69
| | | | | | Fixes #256 Signed-off-by: Nils VAN ZUIJLEN <nils.van-zuijlen@mailo.com>
* Update docs/setup/docker.mdmrdrogdrog2020-11-151-1/+1
| | | Co-authored-by: Philip Molares <git@molar.es>
* Update docs/setup/docker.mdmrdrogdrog2020-11-151-1/+1
| | | Co-authored-by: Philip Molares <git@molar.es>
* Correct repo nameTilman Vatteroth2020-11-142-2/+2
| | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* Replace CodiMD with HedgeDocErik Michelson2020-11-146-20/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in public/views Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in README Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in SECURITY.md Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in LICENSE Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in docs/configuration.md Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in bin/setup Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in docs/guides Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in docs/dev Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in docs/guides/auth Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in docs/setup Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update various links in code to the new GitHub org. Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: codiMDVersion.js is now hedgeDocVersion.js Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in docs/setup/yunohost Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rebrand to HedgeDoc: Add banner and logo Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in docs/guides/migrate-etherpad Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Remove note in docs/guides/auth/github Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Replace links in public/docs/features Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Add todo placeholder in docs/history Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Replace github link in public/views/index/body Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Replace github link in README Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Add logo to README Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Add note about the renaming to the front page Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Removed Travis from README.md and change CodiMD to HedgeDoc in some places Signed-off-by: Yannick Bungers <git@innay.de> Some more renaming to HedgeDoc - Fixed capitalization of HedgeDoc - Added renaming for etherpad migration doc Signed-off-by: Yannick Bungers <git@innay.de> Changed Repo name to hedgedoc Signed-off-by: Yannick Bungers <git@innay.de>
* Fixed inconsistencies in documentationYannick Bungers2020-11-121-12/+14
| | | | | | | | | - Updated Node.js requirement - Added warning for older Mysql and MariaDB versions - changed npm commands to yarn commands - changed occurrences of CodiMD to HedgeDoc for easier merging Signed-off-by: Yannick Bungers <git@innay.de>
* Merge pull request #410 from oupala/feature/markdown-lintingDavid Mehren2020-07-106-20/+21
|\
| * style: linting markdown filesoupala2020-07-106-20/+21
| | | | | | | | | | | | | | | | Linting markdown files according to default remark-lint configuration. Files inside the `public` directory were not linted. Signed-off-by: oupala <oupala@users.noreply.github.com>
* | Create yunohost.mdericgaspar2020-07-021-0/+8
|/ | | | | | Signed-off-by: ericgaspar <junk.eg@free.fr> Add setup doc about deploying CodiMD with YunoHost.
* Merge pull request #398 from gramakri/patch-1Sheogorath2020-06-201-1/+6
|\ | | | | Update Cloudron docs
| * Update Cloudron docsGirish Ramakrishnan2020-06-121-1/+6
| | | | | | | | | | | | Added a link to the demo and source code repo Signed-off-by: Girish Ramakrishnan <girish@cloudron.io>
* | fix: outdated internal links in documentationoupala2020-06-201-7/+6
|/ | | | Signed-off-by: oupala <oupala@users.noreply.github.com>
* [DOC] Use `npm start`, not `yarn start` to startEnrico Guiraud2019-12-201-2/+2
| | | | | | | `yarn start --production` ignores the `--production` flag, `npm start --production` does not. Signed-off-by: Enrico Guiraud <enrico.guiraud@cern.ch>
* [DOC] Misc improvements to manual setup instructionsEnrico Guiraud2019-12-201-5/+10
| | | | Signed-off-by: Enrico Guiraud <enrico.guiraud@cern.ch>
* Replaces `npm` with `yarn` commands in docs.Jonas Zohren2019-10-251-4/+4
| | | | Signed-off-by: Jonas Zohren <jonas.zohren@tu-dortmund.de>
* Slightly improve docker-linux-server.mdSalim B2019-08-011-4/+4
| | | | | | | | - fix typo - add link to PhantomJS - improve formatting Signed-off-by: Salim B <salim@posteo.de>
* Fix some minor quirks in the LinuxServer.io docsSheogorath2019-08-011-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-122-1/+15
| | | | | 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>
* drop node 6 supportClaudius2019-05-131-1/+1
| | | | | | | | We will no longer test on node6 and instead focus on 8+. This won't break node6 immediately, but we will no longer go out of our way supporting a version that does not receive security updates. Signed-off-by: Claudius <opensource@amenthes.de>
* asyncified setting and verifying the passwordClaudius2019-05-131-1/+0
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* Add name of directory to clone intoMauricio Robayo2019-05-051-1/+1
| | | | Signed-off-by: Mauricio Robayo <rfmajo@gmail.com>
* fixing manual upgrade instructions and completing requirementsClaudius2019-04-151-18/+19
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* striving for consistency across various docsClaudius2019-04-015-7/+13
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* splitting README.md into files in /docs for better readabilityClaudius2019-04-015-0/+75
Signed-off-by: Claudius <opensource@amenthes.de>