mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-22 11:15:23 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Change links in README

Browse source 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
This commit is contained in:
Tilman Vatteroth 2021-01-05 17:13:44 +01:00
parent bcc99f7979
commit 929a27d393
No known key found for this signature in database
GPG key ID: DEBDB3F34641B019
1 changed files with 20 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -12,7 +12,7 @@ it by visiting our [HedgeDoc demo server][hedgedoc-demo].
It is inspired by Hackpad, Etherpad and similar collaborative editors. This It is inspired by Hackpad, Etherpad and similar collaborative editors. This
project originated with the team at [HackMD](https://hackmd.io) and now forked project originated with the team at [HackMD](https://hackmd.io) and now forked
into its own organisation. [A longer writeup can be read in the history doc](docs/history.md). into its own organisation. [A longer writeup can be read in the history][history].
[![HedgeDoc 1.7.0 with its feature demonstration page open](public/screenshot.png)][hedgedoc-demo-features] [![HedgeDoc 1.7.0 with its feature demonstration page open](public/screenshot.png)][hedgedoc-demo-features]
@ -21,7 +21,7 @@ into its own organisation. [A longer writeup can be read in the history doc](doc
We welcome contributions! There's a lot to do: If you would like to report bugs, We welcome contributions! There's a lot to do: If you would like to report bugs,
the [issue tracker][github-issue-tracker] is the right place. If you can help the [issue tracker][github-issue-tracker] is the right place. If you can help
translating, find us on [POEditor][poeditor-url]. To get started developing, translating, find us on [POEditor][poeditor-url]. To get started developing,
take a look at the [docs/dev](docs/dev) directory. In any case: come talk to us, take a look at the [developer documentation][developer-documentation]. In any case: come talk to us,
we'll be delighted to help you with the first steps. we'll be delighted to help you with the first steps.
To stay up to date with our work or get support it's recommended to join our To stay up to date with our work or get support it's recommended to join our
@ -34,20 +34,20 @@ regular [community calls][hedgedoc-community-calls] ([RSS](https://community.hed
You can run HedgeDoc in a number of ways, and we created setup instructions for You can run HedgeDoc in a number of ways, and we created setup instructions for
all of these: all of these:
- [Docker](docs/setup/docker.md) - [Docker][setup-docker]
- [Cloudron](docs/setup/cloudron.md) - [Cloudron][setup-cloudron]
- [LinuxServer.io (multi-arch docker)](docs/setup/docker-linuxserver.md) - [LinuxServer.io (multi-arch docker)][setup-docker-linuxserver]
- [Heroku](docs/setup/heroku.md) - [Heroku][setup-heroku]
- [Manual setup](docs/setup/manual-setup.md) - [Manual setup][setup-manual]
## Configuration ## Configuration
Theres two main ways to [configure](docs/configuration.md) your HedgeDoc instance: Theres two main ways to [configure][configuration] your HedgeDoc instance:
config file or environment variables. You can choose what works best for you. config file or environment variables. You can choose what works best for you.
HedgeDoc can integrate with HedgeDoc can integrate with
- facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and [oauth2](docs/guides/auth/oauth.md) **for login** - facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and [oauth2][configuration-oauth] **for login**
- imgur, s3, minio, azure **for image/attachment storage** (files can also be local!) - imgur, s3, minio, azure **for image/attachment storage** (files can also be local!)
- dropbox **for export and import** - dropbox **for export and import**
@ -72,7 +72,7 @@ To backup HedgeDoc, you should:
- backup your database - backup your database
- backup your custom config file if you have one - backup your custom config file if you have one
- backup the upload folder (see the [uploadsPath](./docs/configuration.md#hedgedoc-paths-stuff) config directive) - backup the upload folder (see the [uploadsPath][configuration-paths] config directive)
Restoring an existing instance of HedgeDoc is then just a matter of restoring these elements. Restoring an existing instance of HedgeDoc is then just a matter of restoring these elements.
@ -87,6 +87,16 @@ Licensed under AGPLv3. For our list of contributors, see [AUTHORS](AUTHORS).
The license does not include the HedgeDoc logo, whose terms of usage can be found in the [github repository](https://github.com/hedgedoc/hedgedoc-logo). The license does not include the HedgeDoc logo, whose terms of usage can be found in the [github repository](https://github.com/hedgedoc/hedgedoc-logo).
[configuration-oauth]: https://docs.hedgedoc.org/configuration/#oauth2-login
[configuration]: https://docs.hedgedoc.org/configuration/
[configuration-paths]: https://docs.hedgedoc.org/configuration/#hedgedoc-paths-stuff
[setup-docker]: https://docs.hedgedoc.org/setup/docker/
[setup-cloudron]: https://docs.hedgedoc.org/setup/cloudron/
[setup-docker-linuxserver]: https://docs.hedgedoc.org/setup/docker-linuxserver/
[setup-heroku]: https://docs.hedgedoc.org/setup/heroku/
[setup-manual]: https://docs.hedgedoc.org/setup/manual-setup/
[developer-documentation]: https://docs.hedgedoc.org/dev/getting-started/
[history]: https://hedgedoc.org/history
[matrix.org-image]: https://img.shields.io/matrix/hedgedoc:matrix.org?logo=matrix&server_fqdn=matrix.org [matrix.org-image]: https://img.shields.io/matrix/hedgedoc:matrix.org?logo=matrix&server_fqdn=matrix.org
[matrix.org-url]: https://chat.hedgedoc.org [matrix.org-url]: https://chat.hedgedoc.org
[github-version-badge]: https://img.shields.io/github/release/hedgedoc/hedgedoc.svg [github-version-badge]: https://img.shields.io/github/release/hedgedoc/hedgedoc.svg