README.md 1.59 KB
Newer Older
1
HedgeDoc container
greyia's avatar
greyia committed
2 3
===

4 5 6
![Test status](https://github.com/hedgedoc/container/workflows/Tests/badge.svg)
[![#hedgedoc on matrix.org](https://img.shields.io/badge/Matrix.org-%23hedgedoc@matrix.org-green.svg)](https://chat.hedgedoc.org)
[![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)
7

8
This repository contains resources for building the official HedgeDoc containers published to quay.io.
9

10
## Getting Started
Sheogorath's avatar
Sheogorath committed
11

12 13
Have a look at our [getting started guide](https://docs.hedgedoc.org/setup/getting-started/) and follow the instructions 
for Docker.
Max Wu's avatar
Max Wu committed
14

15
# Documentation
16

17
The official docs can be found at https://docs.hedgedoc.org/setup/docker/.
18

19 20
They are maintained in the [main HedgeDoc repository](https://github.com/hedgedoc/hedgedoc/blob/master/docs/content/setup/docker.md),
so PRs must be filed over there.
21 22 23

# License

24 25
View [license information](https://github.com/hedgedoc/hedgedoc) for the
software contained in this image.
26 27 28 29 30

# User Feedback

## Issues

31 32
If you have any problems with or questions about this image, please contact us
through a [GitHub issue](https://github.com/hedgedoc/container/issues).
33

34 35
You can also reach many of the project maintainers via our matrix room
[`#hedgedoc:matrix.org`](https://chat.hedgedoc.org).
36 37 38 39


## Contributing

40 41 42
You are invited to contribute new features, fixes, or updates, large or small;
we are always thrilled to receive pull requests, and do our best to process
them as fast as we can.
Max Wu's avatar
Max Wu committed
43 44


45
**Happy HedgeDoc :smile:**