Gitlab Community Edition Instance

README.md 5.9 KB
Newer Older
Gregor Thiem's avatar
Gregor Thiem committed
1
![HedgeDoc Logo](docs/content/images/hedgedoc_logo_black.svg)
hholder's avatar
hholder committed
2

Gregor Thiem's avatar
Gregor Thiem committed
3
4
5
# HedgeDoc

[![#HedgeDoc on matrix.org][matrix.org-image]][matrix.org-url]
hholder's avatar
hholder committed
6
7
[![version][github-version-badge]][github-release-page]
[![POEditor][poeditor-image]][poeditor-url]
hholder's avatar
hholder committed
8
[![Mastodon][social-mastodon-image]][social-mastodon]
hholder's avatar
hholder committed
9

Gregor Thiem's avatar
Gregor Thiem committed
10
11
HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive
it by visiting our [HedgeDoc demo server][hedgedoc-demo].
hholder's avatar
hholder committed
12
13
14

It is inspired by Hackpad, Etherpad and similar collaborative editors. This
project originated with the team at [HackMD](https://hackmd.io) and now forked
Gregor Thiem's avatar
Gregor Thiem committed
15
into its own organisation. [A longer writeup can be read in the history][history].
hholder's avatar
hholder committed
16

Gregor Thiem's avatar
Gregor Thiem committed
17
[![HedgeDoc 1.7.0 with its feature demonstration page open](public/screenshot.png)][hedgedoc-demo-features]
hholder's avatar
hholder committed
18
19
20
21
22
23

## Community and Contributions

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
translating, find us on [POEditor][poeditor-url]. To get started developing,
Gregor Thiem's avatar
Gregor Thiem committed
24
take a look at the [developer documentation][developer-documentation]. In any case: come talk to us,
hholder's avatar
hholder committed
25
26
27
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
Gregor Thiem's avatar
Gregor Thiem committed
28
[Matrix channel][matrix.org-url], stop by our [community forums][hedgedoc-community]
hholder's avatar
hholder committed
29
or subscribe to the [release feed][github-release-feed]. We also engage in
Gregor Thiem's avatar
Gregor Thiem committed
30
regular [community calls][hedgedoc-community-calls] ([RSS](https://community.hedgedoc.org/t/codimd-community-call/19.rss)) which you are very welcome to join.
hholder's avatar
hholder committed
31
32
33

## Installation / Upgrading

Gregor Thiem's avatar
Gregor Thiem committed
34
You can run HedgeDoc in a number of ways, and we created setup instructions for
hholder's avatar
hholder committed
35
36
all of these:

Gregor Thiem's avatar
Gregor Thiem committed
37
38
39
40
41
- [Docker][setup-docker]
- [Cloudron][setup-cloudron]
- [LinuxServer.io (multi-arch docker)][setup-docker-linuxserver]
- [Heroku][setup-heroku]
- [Manual setup][setup-manual]
hholder's avatar
hholder committed
42
43
44

## Configuration

Gregor Thiem's avatar
Gregor Thiem committed
45
Theres two main ways to [configure][configuration] your HedgeDoc instance:
Gregor Thiem's avatar
Gregor Thiem committed
46
config file or environment variables. You can choose what works best for you.
hholder's avatar
hholder committed
47

Gregor Thiem's avatar
Gregor Thiem committed
48
HedgeDoc can integrate with
hholder's avatar
hholder committed
49

Gregor Thiem's avatar
Gregor Thiem committed
50
- facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and [oauth2][configuration-oauth] **for login**
Gregor Thiem's avatar
Gregor Thiem committed
51
52
- imgur, s3, minio, azure **for image/attachment storage** (files can also be local!)
- dropbox **for export and import**
hholder's avatar
hholder committed
53
54
55
56
57

More info about that can be found in the configuration docs above.

## Browser support

Gregor Thiem's avatar
Gregor Thiem committed
58
To use HedgeDoc, your browser should match or exceed these versions:
hholder's avatar
hholder committed
59

Gregor Thiem's avatar
Gregor Thiem committed
60
61
62
- ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/chrome/chrome_24x24.png) Chrome >= 47, ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/chrome/chrome_24x24.png) Chrome for Android >= 47
- ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/safari/safari_24x24.png) Safari >= 9, ![iOS Safarai](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/safari-ios/safari-ios_24x24.png) iOS Safari >= 8.4
- ![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/firefox/firefox_24x24.png) Firefox >= 44
Gregor Thiem's avatar
Gregor Thiem committed
63
64
65
66
- ![Edge](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/edge/edge_24x24.png) Edge >= 12
- ![Opera](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/opera/opera_24x24.png) Opera >=
  34, ![Opera Mini](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/opera-mini/opera-mini_24x24.png)
  Opera Mini not supported
Gregor Thiem's avatar
Gregor Thiem committed
67
- ![Android Browser](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/android-webview-beta/android-webview-beta_24x24.png) Android Browser >= 4.4
hholder's avatar
hholder committed
68

Gregor Thiem's avatar
Gregor Thiem committed
69
## Backup/restore your instance
hholder's avatar
hholder committed
70

Gregor Thiem's avatar
Gregor Thiem committed
71
72
73
74
To backup HedgeDoc, you should:

- backup your database
- backup your custom config file if you have one
Gregor Thiem's avatar
Gregor Thiem committed
75
- backup the upload folder (see the [uploadsPath][configuration-paths] config directive) 
hholder's avatar
hholder committed
76

Gregor Thiem's avatar
Gregor Thiem committed
77
Restoring an existing instance of HedgeDoc is then just a matter of restoring these elements.
hholder's avatar
hholder committed
78

Gregor Thiem's avatar
Gregor Thiem committed
79
## Related Tools
hholder's avatar
hholder committed
80

Gregor Thiem's avatar
Gregor Thiem committed
81
82
83
84
Our community has created related tools, we'd like to highlight [hedgedoc-cli](https://github.com/hedgedoc/cli)
which lets you use HedgeDoc from the comfort of your command line.

## License
hholder's avatar
hholder committed
85

hholder's avatar
hholder committed
86
Licensed under AGPLv3. For our list of contributors, see [AUTHORS](AUTHORS).
hholder's avatar
hholder committed
87

Gregor Thiem's avatar
Gregor Thiem committed
88
89
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).

Gregor Thiem's avatar
Gregor Thiem committed
90
91
92
93
94
95
96
97
98
99
[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://docs.hedgedoc.org/history/
Gregor Thiem's avatar
Gregor Thiem committed
100
101
102
103
104
105
[matrix.org-image]: https://img.shields.io/matrix/hedgedoc:matrix.org?logo=matrix&server_fqdn=matrix.org
[matrix.org-url]: https://chat.hedgedoc.org
[github-version-badge]: https://img.shields.io/github/release/hedgedoc/hedgedoc.svg
[github-release-page]: https://github.com/hedgedoc/hedgedoc/releases
[github-release-feed]: https://github.com/hedgedoc/hedgedoc/releases.atom
[github-issue-tracker]: https://github.com/hedgedoc/hedgedoc/issues/
hholder's avatar
hholder committed
106
[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg
hholder's avatar
hholder committed
107
[poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir
Gregor Thiem's avatar
Gregor Thiem committed
108
109
110
111
112
113
[hedgedoc-demo]: https://demo.hedgedoc.org
[hedgedoc-demo-features]: https://demo.hedgedoc.org/features
[hedgedoc-community]: https://community.hedgedoc.org
[hedgedoc-community-calls]: https://community.hedgedoc.org/t/codimd-community-call/19
[social-mastodon]: https://social.hedgedoc.org/mastodon
[social-mastodon-image]: https://img.shields.io/mastodon/follow/49593?domain=https%3A%2F%2Fsocial.snopyta.org&style=social