Gitlab Community Edition Instance

README.md 5.53 KB
Newer Older
Gregor Thiem's avatar
Gregor Thiem committed
1
![HedgeDoc Logo](docs/images/hedgedoc_logo_horizontal.png)
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
15
16

It is inspired by Hackpad, Etherpad and similar collaborative editors. This
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).

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

## 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,
take a look at the [docs/dev](docs/dev) directory. In any case: come talk to us,
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
42
- [Docker](docs/setup/docker.md)
- [Kubernetes](docs/setup/kubernetes.md)
- [Cloudron](docs/setup/cloudron.md)
- [LinuxServer.io (multi-arch docker)](docs/setup/docker-linuxserver.md)
- [Heroku](docs/setup/heroku.md)
- [Manual setup](docs/setup/manual-setup.md)
hholder's avatar
hholder committed
43
44
45

## Configuration

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

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

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

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

## Browser support

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

Gregor Thiem's avatar
Gregor Thiem committed
61
62
63
64
65
66
- ![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
- ![IE](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/archive/internet-explorer_9-11/internet-explorer_9-11_24x24.png) IE >= 9, ![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
- ![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
67

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

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

- backup your database
- backup your custom config file if you have one
- backup the upload folder (see the [uploadsPath](./docs/configuration.md#hedgedoc-paths-stuff) config directive) 
hholder's avatar
hholder committed
75

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

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

Gregor Thiem's avatar
Gregor Thiem committed
80
81
82
83
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
84

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

Gregor Thiem's avatar
Gregor Thiem committed
87
88
89
90
91
92
93
94
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).

[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
95
[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg
hholder's avatar
hholder committed
96
[poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir
Gregor Thiem's avatar
Gregor Thiem committed
97
98
99
100
101
102
[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