-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
modified: docs/index.md // removed: docs/tutorial/getting-started.md,…
…docs/how-to/contribute.md,docs/reference/actions.md,docs/reference/integrations.md,docs/explanation/charm-architecture.md
- Loading branch information
1 parent
7147f84
commit 6c4d6ea
Showing
6 changed files
with
17 additions
and
472 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,25 @@ | ||
# Synapse Operator | ||
A Juju charm deploying and managing [Synapse](https://github.com/matrix-org/synapse) on Kubernetes. Synapse is a drop in replacement for other chat servers like Mattermost and Slack. | ||
|
||
A Juju charm deploying and managing [Synapse](https://github.com/matrix-org/synapse) on Kubernetes. | ||
Synapse is a drop in replacement for other chat servers like Mattermost and | ||
Slack. | ||
This charm simplifies initial deployment and "day N" operations of Synapse on Kubernetes, such as integration with SSO, access to S3 for redundant file storage and more. It allows for deployment on | ||
many different Kubernetes platforms, from [MicroK8s](https://microk8s.io) to [Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes offerings. | ||
|
||
This charm simplifies initial deployment and “day N” operations of Synapse on | ||
Kubernetes, such as integration with SSO, access to S3 for redundant file | ||
storage and more. It allows for deployment on many different Kubernetes | ||
platforms, from [MicroK8s](https://microk8s.io) to [Charmed Kubernetes](https://ubuntu.com/kubernetes) | ||
to public cloud Kubernetes offerings. | ||
As such, the charm makes it easy for those looking to take control of their own Chat server whilst keeping operations simple, and gives them the freedom to deploy on the Kubernetes platform of their choice. | ||
|
||
As such, the charm makes it easy for those looking to take control of their own | ||
Chat server whilst keeping operations simple, and gives them the freedom to | ||
deploy on the Kubernetes platform of their choice. | ||
|
||
For DevOps or SRE teams this charm will make operating Synapse simple and | ||
straightforward through Juju’s clean interface. It will allow easy deployment | ||
into multiple environments for testing of changes. | ||
For DevOps or SRE teams this charm will make operating Synapse simple and straightforward through Juju's clean interface. It will allow easy deployment into multiple environments for testing of changes. | ||
|
||
## Project and community | ||
|
||
The Synapse Operator is a member of the Ubuntu family. It's an open source | ||
project that warmly welcomes community projects, contributions, suggestions, | ||
fixes and constructive feedback. | ||
Synapse is an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback. | ||
|
||
* [Read our Code of Conduct](https://ubuntu.com/community/code-of-conduct) | ||
* [Join the Discourse forum](https://discourse.charmhub.io/tag/synapse) | ||
* [Discuss on the Mattermost chat service](https://chat.charmhub.io/charmhub/channels/charm-dev) | ||
* Contribute and report bugs to [the Synapse operator](https://github.com/canonical/synapse-operator) | ||
|
||
## Contributing to this documentation | ||
|
||
Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the [Charmhub forum](https://discourse.charmhub.io/) to enable easy collaboration. Please use the “Help us improve this documentation” links on each documentation page to either directly change something you see that’s wrong, or ask a question, or make a suggestion about a potential change via the comments section. | ||
|
||
- [Code of conduct](https://ubuntu.com/community/code-of-conduct) | ||
- [Get support](https://discourse.charmhub.io/) | ||
- [Join our online chat](https://chat.charmhub.io/charmhub/channels/charm-dev) | ||
- [Contribute](https://charmhub.io/synapse/docs/how-to-contribute) | ||
If there’s a particular area of documentation that you’d like to see that’s missing, please [file a bug](https://github.com/canonical/synapse-operator/issues). | ||
|
||
Thinking about using the Synapse Operator for your next project? | ||
[Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)! | ||
# Contents |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.