summaryrefslogtreecommitdiff
path: root/docs/setup
diff options
context:
space:
mode:
authorDavid Mehren2020-11-15 21:02:36 +0100
committerGitHub2020-11-15 21:02:36 +0100
commit4c0efe1237bc33b52d06eaf86a28adad9a041ec2 (patch)
treefa068d16074645b7b6d8d88b78724b9cd82dd879 /docs/setup
parent299301f0fe5bea41b4407bbbc03932fc4dd1c1d3 (diff)
parent9898ab3ca5fa226967d8a3aca8e6e752554ed64d (diff)
Merge pull request #453 from hedgedoc/misc/renaming
Diffstat (limited to 'docs/setup')
-rw-r--r--docs/setup/cloudron.md4
-rw-r--r--docs/setup/docker-linuxserver.md8
-rw-r--r--docs/setup/docker.md16
-rw-r--r--docs/setup/heroku.md4
-rw-r--r--docs/setup/kubernetes.md2
-rw-r--r--docs/setup/manual-setup.md2
-rw-r--r--docs/setup/yunohost.md6
7 files changed, 21 insertions, 21 deletions
diff --git a/docs/setup/cloudron.md b/docs/setup/cloudron.md
index f2ba8b97..3085e6bd 100644
--- a/docs/setup/cloudron.md
+++ b/docs/setup/cloudron.md
@@ -1,10 +1,10 @@
# Cloudron
-CodiMD is available as a 1-click install on [Cloudron](https://cloudron.io). Cloudron makes it easy to run apps like CodiMD on your server and keep them up-to-date and secure.
+HedgeDoc is available as a 1-click install on [Cloudron](https://cloudron.io). Cloudron makes it easy to run apps like HedgeDoc on your server and keep them up-to-date and secure.
[![Install](https://cloudron.io/img/button.svg)](https://cloudron.io/button.html?app=io.hackmd.cloudronapp)
The source code for the package can be found [here](https://git.cloudron.io/cloudron/codimd-app).
There is a [demo instance](https://my.demo.cloudron.io) (username: cloudron password: cloudron) where
-you can experiment with running CodiMD.
+you can experiment with running HedgeDoc.
diff --git a/docs/setup/docker-linuxserver.md b/docs/setup/docker-linuxserver.md
index 344bcfab..58d5c8da 100644
--- a/docs/setup/docker-linuxserver.md
+++ b/docs/setup/docker-linuxserver.md
@@ -1,12 +1,12 @@
-# LinuxServer.io CodiMD Image
+# LinuxServer.io HedgeDoc Image
[![LinuxServer.io Discord](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)[![container version badge](https://images.microbadger.com/badges/version/linuxserver/codimd.svg)](https://microbadger.com/images/linuxserver/codimd "Get your own version badge on microbadger.com")[![container image size badge](https://images.microbadger.com/badges/image/linuxserver/codimd.svg)](https://microbadger.com/images/linuxserver/codimd "Get your own version badge on microbadger.com")![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/codimd.svg)![Docker Stars](https://img.shields.io/docker/stars/linuxserver/codimd.svg)[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-codimd/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-codimd/job/master/)[![LinuxServer.io CI summary](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codimd/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codimd/latest/index.html)
[LinuxServer.io](https://linuxserver.io) have created an Ubuntu-based multi-arch container image for x86-64, arm64 and armhf which supports PDF export from all architectures using [PhantomJS](https://phantomjs.org/).
- It supports all the environment variables detailed in the [configuration documentation](../configuration-env-vars.md) to modify it according to your needs.
-- It gets rebuilt on new releases from CodiMD and also weekly if necessary to update any other package changes in the underlying container, making it easy to keep your CodiMD instance up to date.
-- It also details how to easily [utilize Docker networking to reverse proxy](https://github.com/linuxserver/docker-codimd/#application-setup) CodiMD using their [LetsEncrypt docker image](https://github.com/linuxserver/docker-letsencrypt)
+- It gets rebuilt on new releases from HedgeDoc and also weekly if necessary to update any other package changes in the underlying container, making it easy to keep your HedgeDoc instance up to date.
+- It also details how to easily [utilize Docker networking to reverse proxy](https://github.com/linuxserver/docker-codimd/#application-setup) HedgeDoc using their [LetsEncrypt docker image](https://github.com/linuxserver/docker-letsencrypt)
-In order to contribute check the LinuxServer.io [GitHub repository](https://github.com/linuxserver/docker-codimd/) for CodiMD.
+In order to contribute check the LinuxServer.io [GitHub repository](https://github.com/linuxserver/docker-codimd/) for HedgeDoc.
And to find all tags and versions of the image, check the [Docker Hub repository](https://hub.docker.com/r/linuxserver/codimd).
diff --git a/docs/setup/docker.md b/docs/setup/docker.md
index a9a8b240..f6aeb833 100644
--- a/docs/setup/docker.md
+++ b/docs/setup/docker.md
@@ -1,20 +1,20 @@
-# CodiMD Docker Image
+# HedgeDoc Docker Image
-[![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://github.com/codimd/container/raw/master/docker-compose.yml&stack_name=codimd)
+[![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://github.com/hedgedoc/container/raw/master/docker-compose.yml&stack_name=hedgedoc)
## Debian-based version
-[![Docker Repository on Quay](https://quay.io/repository/codimd/server/status "Docker Repository on Quay")](https://quay.io/repository/codimd/server)
+[![Docker Repository on Quay](https://quay.io/repository/hedgedoc/hedgedoc/status "Docker Repository on Quay")](https://quay.io/repository/hedgedoc/hedgedoc)
## Alpine-based version
-[![Docker Repository on Quay](https://quay.io/repository/codimd/server/status "Docker Repository on Quay")](https://quay.io/repository/codimd/server)
+[![Docker Repository on Quay](https://quay.io/repository/hedgedoc/hedgedoc/status "Docker Repository on Quay")](https://quay.io/repository/hedgedoc/hedgedoc)
-The easiest way to setup CodiMD using docker are using the following three commands:
+The easiest way to setup HedgeDoc using docker are using the following three commands:
```sh
-git clone https://github.com/codimd/container.git codimd-container
-cd codimd-container
+git clone https://github.com/hedgedoc/container.git hedgedoc-container
+cd hedgedoc-container
docker-compose up
```
-Read more about it in the [container repository](https://github.com/codimd/container).
+Read more about it in the [container repository](https://github.com/hedgedoc/container).
diff --git a/docs/setup/heroku.md b/docs/setup/heroku.md
index 9f62e58c..e6280051 100644
--- a/docs/setup/heroku.md
+++ b/docs/setup/heroku.md
@@ -1,6 +1,6 @@
# Heroku Deployment
-You can quickly setup a sample Heroku CodiMD application by clicking the button
+You can quickly setup a sample Heroku HedgeDoc application by clicking the button
below.
-[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/codimd/server/tree/master)
+[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/hedgedoc/hedgedoc/tree/master)
diff --git a/docs/setup/kubernetes.md b/docs/setup/kubernetes.md
index 91c57188..6706b911 100644
--- a/docs/setup/kubernetes.md
+++ b/docs/setup/kubernetes.md
@@ -2,4 +2,4 @@
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).
+For all further details, please check out the offical HedgeDoc [K8s helm chart](https://github.com/kubernetes/charts/tree/master/stable/hackmd).
diff --git a/docs/setup/manual-setup.md b/docs/setup/manual-setup.md
index f197e477..4900093d 100644
--- a/docs/setup/manual-setup.md
+++ b/docs/setup/manual-setup.md
@@ -27,7 +27,7 @@
3. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs.
-4. Modify the file named `config.json` or configure HedgeDoc through environment variables which will overwrite the configs, see docs [here](https://github.com/hedgedoc/server/blob/master/docs/configuration.md).
+4. Modify the file named `config.json` or configure HedgeDoc through environment variables which will overwrite the configs, see docs [here](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md).
5. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development)
diff --git a/docs/setup/yunohost.md b/docs/setup/yunohost.md
index a7666df9..9ec9d45b 100644
--- a/docs/setup/yunohost.md
+++ b/docs/setup/yunohost.md
@@ -1,8 +1,8 @@
YunoHost
===
-CodiMD is available as a 1-click install on [YunoHost](https://yunohost.org/). YunoHost is a Debian GNU/Linux based distribution packaged with free software that automates the installation of a personal web server.
+HedgeDoc is available as a 1-click install on [YunoHost](https://yunohost.org/). YunoHost is a Debian GNU/Linux based distribution packaged with free software that automates the installation of a personal web server.
-[![Install CodiMD with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=codimd)
+[![Install HedgeDoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=codimd)
-The source code for the package can be found [here](https://github.com/YunoHost-Apps/codimd_ynh). \ No newline at end of file
+The source code for the package can be found [here](https://github.com/YunoHost-Apps/codimd_ynh).