mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2025-05-13 06:34:39 -04:00
Delete old docs not relevant for 2.x
Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren
parent
7bf3f59dd8
commit
effba43fe8
81 changed files with 1 additions and 2551 deletions
|
|
@ -1,6 +0,0 @@
|
|||
Cloudron
|
||||
===
|
||||
|
||||
Install CodiMD on [Cloudron](https://cloudron.io):
|
||||
|
||||
[](https://cloudron.io/button.html?app=io.hackmd.cloudronapp)
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
# LinuxServer.io HedgeDoc Image
|
||||
|
||||
[](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
|
||||
[](https://github.com/linuxserver/docker-hedgedoc/releases)
|
||||
[](https://github.com/linuxserver/docker-hedgedoc/packages)
|
||||
[](https://gitlab.com/linuxserver.io/docker-hedgedoc/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/hedgedoc "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/hedgedoc)
|
||||
[](https://hub.docker.com/r/linuxserver/hedgedoc)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hedgedoc/job/main/)
|
||||
[](https://ci-tests.linuxserver.io/linuxserver/hedgedoc/latest/index.html)
|
||||
|
||||
[LinuxServer.io](https://linuxserver.io) have created an Ubuntu-based multi-arch container image for x86-64, arm64 and
|
||||
armhf.
|
||||
|
||||
- It supports all the environment variables detailed in the [configuration documentation](../configuration.md) to modify
|
||||
it according to your needs.
|
||||
- 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-hedgedoc/#application-setup)
|
||||
HedgeDoc using their [SWAG docker image](https://github.com/linuxserver/docker-swag)
|
||||
|
||||
In order to contribute check the LinuxServer.io [GitHub repository](https://github.com/linuxserver/docker-hedgedoc/) for
|
||||
HedgeDoc. And to find all tags and versions of the image, check
|
||||
the [Docker Hub repository](https://hub.docker.com/r/linuxserver/hedgedoc).
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
CodiMD Docker Image
|
||||
===
|
||||
|
||||
[](http://play-with-docker.com?stack=https://github.com/codimd/container/raw/master/docker-compose.yml&stack_name=codimd)
|
||||
|
||||
|
||||
**Debian-based version:**
|
||||
|
||||
[](https://quay.io/repository/codimd/server)
|
||||
|
||||
|
||||
**Alpine-based version:**
|
||||
|
||||
[](https://quay.io/repository/codimd/server)
|
||||
|
||||
The easiest way to setup CodiMD using docker are using the following three commands:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/codimd/container.git codimd-container
|
||||
cd codimd-container
|
||||
docker-compose up
|
||||
```
|
||||
Read more about it in the [container repository](https://github.com/codimd/container).
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
Heroku Deployment
|
||||
===
|
||||
|
||||
You can quickly setup a sample Heroku CodiMD application by clicking the button
|
||||
below.
|
||||
|
||||
[](https://heroku.com/deploy?template=https://github.com/codimd/server/tree/master)
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
Kubernetes
|
||||
===
|
||||
|
||||
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).
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
Manual Installation
|
||||
===
|
||||
|
||||
## Requirements on your server
|
||||
|
||||
- Node.js 8.5 or up
|
||||
- Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL). Must use charset `utf8`: this is typically the
|
||||
default in PostgreSQL and SQLite, while in MySQL and MariaDB utf8 might need to be set with
|
||||
`alter database <DBNAME> character set utf8 collate utf8_bin;`
|
||||
- npm (and its dependencies, [node-gyp](https://github.com/nodejs/node-gyp#installation))
|
||||
- yarn
|
||||
- Bash (for the setup script)
|
||||
- For **building** CodiMD we recommend to use a machine with at least **2GB** RAM
|
||||
|
||||
|
||||
## Instructions
|
||||
|
||||
1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server).
|
||||
2. Clone this repository (preferred) or download a release and unzip it.
|
||||
3. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs.
|
||||
4. Modify `config.json`, see docs [here](https://github.com/codimd/server/blob/master/docs/configuration-config-file.md).
|
||||
5. Instead of modifying `config.json`, it's possible to configure CodiMD through environment variables which will
|
||||
overwrite the configs, see docs [here](https://github.com/codimd/server/blob/master/docs/configuration-env-vars.md).
|
||||
6. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development)
|
||||
7. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string. For example:
|
||||
- `postgres://username:password@localhost:5432/codimd`
|
||||
- `mysql://username:password@localhost:3306/codimd`
|
||||
- `sqlite://:memory:`
|
||||
8. It is recommended to start your server manually once: `npm start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
|
||||
9. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts)
|
||||
|
||||
|
||||
## How to upgrade your installation
|
||||
|
||||
If you are upgrading CodiMD from an older version, follow these steps:
|
||||
|
||||
1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server).
|
||||
2. Verify which version you were running before and take a look at [migrations and breaking changes](../guides/migrations-and-breaking-changes.md) to see if additional steps, or configuration changes are necessary!
|
||||
3. Fully stop your old CodiMD server.
|
||||
4. `git pull` or unzip a new release in the directory.
|
||||
5. Run `bin/setup`. This will take care of installing dependencies. It is safe to run on an existing installation.
|
||||
6. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development).
|
||||
7. It is recommended to start your server manually once: `npm start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
|
||||
8. You can now restart the CodiMD server!
|
||||
|
|
@ -1,96 +0,0 @@
|
|||
# Using a Reverse Proxy with HedgeDoc
|
||||
|
||||
If you want to use a reverse proxy to serve HedgeDoc, here are the essential configs that you'll have to do.
|
||||
|
||||
This documentation will cover HTTPS setup, with comments for HTTP setup.
|
||||
|
||||
## HedgeDoc config
|
||||
|
||||
[Full explanation of the configuration options](../configuration.md)
|
||||
|
||||
| `config.json` parameter | Environment variable | Value | Example |
|
||||
|-------------------------|----------------------|-------|---------|
|
||||
| `domain` | `CMD_DOMAIN` | The full domain where your instance will be available | `hedgedoc.example.com` |
|
||||
| `host` | `CMD_HOST` | An ip or domain name that is only available to HedgeDoc and your reverse proxy | `localhost` |
|
||||
| `port` | `CMD_PORT` | An available port number on that IP | `3000` |
|
||||
| `path` | `CMD_PATH` | path to UNIX domain socket to listen on (if specified, `host` or `CMD_HOST` and `port` or `CMD_PORT` are ignored) | `/var/run/hedgedoc.sock` |
|
||||
| `protocolUseSSL` | `CMD_PROTOCOL_USESSL` | `true` if you want to serve your instance over SSL (HTTPS), `false` if you want to use plain HTTP | `true` |
|
||||
| `useSSL` | | `false`, the communications between HedgeDoc and the proxy are unencrypted | `false` |
|
||||
| `urlAddPort` | `CMD_URL_ADDPORT` | `false`, HedgeDoc should not append its port to the URLs it links | `false` |
|
||||
| `hsts.enable` | `CMD_HSTS_ENABLE` | `true` if you host over SSL, `false` otherwise | `true` |
|
||||
|
||||
## Reverse Proxy config
|
||||
|
||||
### Generic
|
||||
|
||||
The reverse proxy must allow websocket `Upgrade` requests at path `/sockets.io/`.
|
||||
|
||||
It must pass through the scheme used by the client (http or https).
|
||||
|
||||
### Nginx
|
||||
|
||||
Here is an example configuration for Nginx.
|
||||
|
||||
```
|
||||
map $http_upgrade $connection_upgrade {
|
||||
default upgrade;
|
||||
'' close;
|
||||
}
|
||||
server {
|
||||
server_name hedgedoc.example.com;
|
||||
|
||||
location / {
|
||||
proxy_pass http://127.0.0.1:3000;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
|
||||
location /socket.io/ {
|
||||
proxy_pass http://127.0.0.1:3000;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection $connection_upgrade;
|
||||
}
|
||||
|
||||
listen [::]:443 ssl http2;
|
||||
listen 443 ssl http2;
|
||||
ssl_certificate fullchain.pem;
|
||||
ssl_certificate_key privkey.pem;
|
||||
include options-ssl-nginx.conf;
|
||||
ssl_dhparam ssl-dhparams.pem;
|
||||
}
|
||||
```
|
||||
|
||||
### Apache
|
||||
|
||||
You will need these modules enabled: `proxy`, `proxy_http` and `proxy_wstunnel`.
|
||||
Here is an example config snippet:
|
||||
|
||||
```
|
||||
<VirtualHost *:443>
|
||||
ServerName hedgedoc.example.com
|
||||
|
||||
RewriteEngine on
|
||||
RewriteCond %{REQUEST_URI} ^/socket.io [NC]
|
||||
RewriteCond %{HTTP:Upgrade} =websocket [NC]
|
||||
RewriteRule /(.*) ws://127.0.0.1:3000/$1 [P,L]
|
||||
|
||||
ProxyPass / http://127.0.0.1:3000/
|
||||
ProxyPassReverse / http://127.0.0.1:3000/
|
||||
|
||||
RequestHeader set "X-Forwarded-Proto" expr=%{REQUEST_SCHEME}
|
||||
|
||||
ErrorLog ${APACHE_LOG_DIR}/error.log
|
||||
CustomLog ${APACHE_LOG_DIR}/access.log combined
|
||||
|
||||
SSLCertificateFile /etc/letsencrypt/live/hedgedoc.example.com/fullchain.pem
|
||||
SSLCertificateKeyFile /etc/letsencrypt/live/hedgedoc.example.com/privkey.pem
|
||||
Include /etc/letsencrypt/options-ssl-apache.conf
|
||||
</VirtualHost>
|
||||
```
|
||||
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
YunoHost
|
||||
===
|
||||
|
||||
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.
|
||||
|
||||
[](https://install-app.yunohost.org/?app=hedgedoc)
|
||||
|
||||
The source code for the package can be found [here](https://github.com/YunoHost-Apps/hedgedoc_ynh).
|
||||
Loading…
Add table
Add a link
Reference in a new issue