lucas.mathieu/cachet-docker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Changes to the readme

Browse Source
This commit is contained in:
James Brooks
2016-08-08 17:30:04 +01:00
parent 657507f1aa
commit 095db8dbbc
1 changed files with 22 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@@ -8,11 +8,7 @@
![Screenshot](https://cachethq.io/img/main-interface.jpg) ![Screenshot](https://cachethq.io/img/main-interface.jpg)
Cachet is a beautiful and powerful open source status page system, a free replacement to services such as StatusPage.io, Status.io and others. Cachet is a beautiful and powerful open source status page system.
## Show your support
Cachet is a BSD-3-licensed open source project. If you'd like to support future development, check out the [Patreon campaign](https://patreon.com/jbrooksuk).
## Features ## Features
@@ -25,11 +21,7 @@ Cachet is a BSD-3-licensed open source project. If you'd like to support future
- Metrics - Metrics
- Cross-database support: MySQL, PostgreSQL and SQLite - Cross-database support: MySQL, PostgreSQL and SQLite
- Subscriber notifications via Email - Subscriber notifications via Email
- Two factor authentication, with Google Authenticator - Two factor authentication using Google Authenticator
## Usage in production
Use of `master` in a production environment is not recommended as it may change at any time.
## Requirements ## Requirements
@@ -37,9 +29,9 @@ Use of `master` in a production environment is not recommended as it may change
- Apache or Nginx server - Apache or Nginx server
- [Composer](https://getcomposer.org) - [Composer](https://getcomposer.org)
## How to contribute ## I'm looking to contribute to this awesome project!
We're always looking for contributions that improve Cachet. It's easy to get started and you don't even need to know how to write a single line of code! Sweet, we're always looking for contributions that improve Cachet! It's easy to get started and you don't even need to know how to write a single line of code!
### Contributing as a non-developer/non-designer ### Contributing as a non-developer/non-designer
@@ -71,11 +63,13 @@ We use these extra dependencies to develop Cachet:
- Gulp - Gulp
- Git - Git
Once cloned to your local machine, you'll need some demo data! Run `php artisan cachet:seed` to get the demo installation on the go. Once cloned to your local machine, you'll need some demo data! Run `php artisan cachet:seed` to get the demo installation ready for action.
## Installation, Upgrades and Documentation ## Installation, Upgrades and Documentation
You can now find our documentation at [https://docs.cachethq.io](https://docs.cachethq.io). Documentation is found at [https://docs.cachethq.io](https://docs.cachethq.io).
Here are some useful quick links:
- [Installing Cachet](https://docs.cachethq.io/docs/installing-cachet) - [Installing Cachet](https://docs.cachethq.io/docs/installing-cachet)
- [Getting started with Docker](https://docs.cachethq.io/docs/get-started-with-docker) - [Getting started with Docker](https://docs.cachethq.io/docs/get-started-with-docker)
@@ -84,10 +78,10 @@ You can now find our documentation at [https://docs.cachethq.io](https://docs.ca
To test out the demo, you may login to the [Dashboard](https://demo.cachethq.io/dashboard) with the following: To test out the demo, you may login to the [Dashboard](https://demo.cachethq.io/dashboard) with the following:
- **Username:** test or test@test.com - **Username:** `test` or `test@test.com`
- **Password:** test123 - **Password:** `test123`
The demo is reset every half hour. The demo is reset every half an hour.
### Release Notes ### Release Notes
@@ -95,14 +89,18 @@ We list releases on the [Releases page](https://github.com/CachetHQ/Cachet/relea
## Translations ## Translations
A special thank you to our [translators](https://crowdin.com/project/cachet/activity_stream), who have allowed us to share Cachet with the world. If you'd like to contribute translations, please check out our [CrowdIn project](https://crowdin.com/project/cachet). If you'd like to contribute translations, please check out our [CrowdIn project](https://crowdin.com/project/cachet).
> Thank you to our [translators](https://crowdin.com/project/cachet/activity_stream), who have allowed us to share Cachet with the world!
## Show your support
Cachet is a BSD-3-licensed open source project. If you'd like to support future development, check out the [Patreon campaign](https://patreon.com/jbrooksuk).
## Professional Installation Service
We offer a professional installation service. To find out more, email us at [support@alt-three.com](mailto:support@alt-three.com?Cachet Installation)
## Security Vulnerabilities ## Security Vulnerabilities
If you discover a security vulnerability within Cachet, please send an e-mail to us at support@alt-three.com. We handle all security vulnerabilities on a case-by-case basis. If you discover a security vulnerability within Cachet, please send an e-mail to us at support@alt-three.com. We handle all security vulnerabilities on a case-by-case basis.
## Installations
We offer a paid installation service, which starts at $99 but is subject to change, dependant on your setup and infrastructure.
To find out more, email us at support@alt-three.com