Update README.md

This commit is contained in:
Vojtěch Sajdl 2018-01-30 18:02:31 +01:00 committed by GitHub
parent 7f3c7cbd37
commit fcd1b87d7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 7 deletions

View File

@ -1,7 +1,7 @@
# Server status page
![screenshot](https://status.trucksbook.eu/img/screenshot.png)
Very simple server status page written in PHP - target version 7, with some code changes it should be able to run almost anywhere. Can run even on shared webhosting without any problems and it was written exactly for that purpose. Because why waste your money on another server (or host on a server that you might want to do maintenance on), when you can use cheap webhosting?
Very simple server status page written in PHP that can run on **PHP 5.3+** - even on **shared webhosting**. Because why waste your money on another server (or host on a server that you might want to do maintenance on), when you can use cheap webhosting?
## How do I install this thing?
Simply put the files on your server and access it from your browser. There will be a simple install dialog waiting for you.
@ -9,25 +9,26 @@ Simply put the files on your server and access it from your browser. There will
You can find more info on [our wiki page](https://github.com/Pryx/server-status/wiki)
## Contributing
Anyone is welcome to make pull request with new features or security patches / bug fixes. You can find some ideas [here](https://github.com/Pryx/server-status/labels/help%20wanted). Only rule for now is, that you should describe what kind of changes you've made to the code in the PR along with some description of the feature or bug fixed so I can test it.
Anyone is welcome to make pull request with new features or security patches / bug fixes. You can find some ideas [here](https://github.com/Pryx/server-status/labels/help%20wanted).
### Translations
Any help with translations is much welcome! You can join us at https://poeditor.com/join/project/37SpmJtyOm. You can even add your own language. Just let me know when you're done and I'm going to include the language in the next release.
[List of contributors](https://github.com/Pryx/server-status/wiki/contributors)
## Translations
Any help with translations is much welcome! You can join us at https://poeditor.com/join/project/37SpmJtyOm. You can even add your own language. Just let me know when you're done and I'm going to include the language in the next release.
## FAQ
### Does it actually run somewhere?
Yes it does! This is basically debranded version of https://status.trucksbook.eu/.
### Is it possible to see how it works somewhere?
Yes it is! Head over to https://demo.status.sajdl.com/admin and try the admin interface for yourself.
### Do you have a demo page?
Yes we have! Head over to https://demo.status.sajdl.com/admin and try the admin interface for yourself.
Login details:
```
email: sysadmin@example.com
password: Ss123456
```
Please note that changes are reverted every hour.
### Why does this project exist?
It was written as a school project where we had to create a website. I went with this because I found the lack of good looking, easy to install and use status page rather weird. Therefore my goal (as stated above) was to create a simplistic status page that could run almost anywhere. The code is not the nicest or cleanest and it definitely doesn't have that many features, but hey, it works!