FreeSTAR Status Engine
Go to file
Yiğit Kerem Oktay 8d571547f5
Merge pull request #135 from server-status-project/master
Merge new updates
2020-11-05 16:52:24 +03:00
.github/ISSUE_TEMPLATE Update stale.yml 2020-09-12 16:41:36 +03:00
admin Revert "Merge branch 'dev' into master" 2020-11-05 16:51:43 +03:00
api added json headers to api response 2018-06-07 21:42:06 +02:00
classes Revert "Merge branch 'dev' into master" 2020-11-05 16:51:43 +03:00
css Revert "Merge branch 'dev' into master" 2020-11-05 16:51:43 +03:00
favicon Logo 2018-01-12 00:42:47 +01:00
fonts Update bootstrap & center line 2018-01-18 23:21:33 +01:00
img Logo 2018-01-12 00:42:47 +01:00
js Fix relative timestamps not properly displaying dates in the future. 2020-06-12 11:30:09 +02:00
locale Çeviriler Güncellendi 2020-08-14 19:12:36 +03:00
404.php Fix #14 - show installation dialog on 404 page if config not found 2018-01-18 22:57:19 +01:00
ApacheHtaccess Create ApacheHtaccess 2020-08-14 15:12:30 +03:00
IISWebConfig Create IISWebConfig 2020-08-14 15:13:12 +03:00
LICENSE License change 2018-09-04 11:13:42 +02:00
README.md Revert "Merge branch 'dev' into master" 2020-11-05 16:51:43 +03:00
config.php.template Revert "Merge branch 'dev' into master" 2020-11-05 16:51:43 +03:00
create-server-config.php Fix a major issue 2020-08-14 21:47:50 +03:00
head.php fix head.php: comment wasn't part of of a php block 2020-09-01 08:28:31 +02:00
index.php Revert "Merge branch 'dev' into master" 2020-11-05 16:51:43 +03:00
install.php Revert "Merge branch 'dev' into master" 2020-11-05 16:51:43 +03:00
install.sql Revert "Merge branch 'dev' into master" 2020-11-05 16:51:43 +03:00
policy.php Revert "Merge branch 'dev' into master" 2020-11-05 16:51:43 +03:00
robots.txt Update jquery, fix #15 - add robots file 2018-01-18 22:56:45 +01:00
template.php Revert "Merge branch 'dev' into master" 2020-11-05 16:51:43 +03:00

README.md

Server status page

License Current release Codacy Badge Discord

screenshot

Very simple server status page written in PHP that can run on PHP 5.4+ - even on shared webhosting even without shell access. 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? And as a cherry on top - it works even without javascript!

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. If you prefer you can install manually by filling the info in config.php.template and renaming it to config.php. As this does not run installation scripts you need to head to your install directory and run create-server-config.php and then delete it. If you don't want to allow php to access your files or you have permission issues, use the following instructions.

Creating server config:

  • IIS: Rename IISWebConfig to web.config
  • Apache: Rename ApacheHtaccess to .htaccess
  • Nginx: You can run with php-fpm no additional modifications required.

You can find more info on our wiki page

Contributing

Anyone is welcome to make pull request with new features or security patches / bug fixes.

You may create a pull request anytime or you can join our discord here(https://discord.gg/Wgxnxz4)

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

Does it actually run somewhere?

Yes it does! https://status.trucksbook.eu/ (Trucksbook) https://status.theskyfallen.com (The Skyfallen Productions Company) https://status.ecidsf.com/ (ECIDSF) https://status.otuts.eu/ (OTUTS) And many more!

FAQ

My Translations are not working. What to do?

  1. Open your shell
  2. Type this command 'sudo nano /etc/locale.gen'
  3. Uncomment all the languages you want.
  4. Save with 'Ctrl+X'
  5. Run 'sudo locale-gen'
  6. Restart apache 'sudo service apache2 restart'
  7. Enjoy!

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.

I noticed there is a new release. How do I update?

Updating server status is fairly straightforward. Download your config.php from the server. Delete all files. Upload the new release with config.php you downloaded earlier. You need to manually run install scripts. For that head to your domain and run create-server-config.php deleting it afterwards. If you don't want to allow php to access your files or you have permission issues, use the following instructions.

Updating server config

Follow the instructions for installation without giving the app write access. Keep in mind that you will need to re-apply any modifications you made.

Is there any way to do this automatically?

We are working on it but it is not yet included. Stay tuned!

Can I somehow pull status info from Server status programatically?

Yes you can! As of 9f7e15f we added API to pull status data... And more APIs are coming! Results are encoded in JSON format which should be pretty easy to use in any common programming language.

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!

Feature Request

You can write an issue and I will try to take a look when I get some time OR you can actually make a fork as the code it GNU licensed. Pull requests are most welcome!


If you like this project, buy us a coffee!

Buy Me A Coffee