diff --git a/README.md b/README.md index db35524..61fe457 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,62 @@ -# THOS-Server +# THOS Server -THOS Server is the open source server for the THOS Operating System \ No newline at end of file +**THOS Server** is the open source backend server for the [THOS Operating System](https://surillya.com/thos), a premium kiosk-style Linux distribution. It handles the whole server, like session persistence, OOBE (Out-of-Box Experience), and local app installer for the THOS ecosystem. + +--- + +![THOS Logo](THOS.png) + +## Features + +- Local PHP server for kiosk-mode environments +- Persistent session and configuration data (beyond cookies/localStorage) +- Built to run smoothly in Chromium or Firefox kiosk mode under Arch or similar + +## 📸 Screenshots + +![Screenshot](screenshots/Screenshot_20250605_140311.png) ![Screenshot](screenshots/Screenshot_20250605_140405.png) ![Screenshot](screenshots/Screenshot_20250605_140518.png) ![Screenshot](screenshots/Screenshot_20250605_140542.png) + +## ⚙️ Setup Instructions + +1. Clone the repo: + + ```bash + git clone https://tea.surillya.com/Surillyacom/THOS-Server.git + cd THOS-Server + ``` + +2. Install dependencies: + + ```bash + sudo pacman -S php + ``` + +3. Launch local server (as sudo): + + ```bash + sudo php -S 0.0.0.0:80 + ``` + +4. Access it in your browser: [http://localhost](http://localhost) + +## 🔒 Security + +The server runs per default as sudo, since it's intended to run server-side commands. This may lead to security issues, so don't just expose it to the web, or give anyone access! And watch out for what apps you install - we recommend only installing *verified* apps from the official THOS store! + +## 🧠 Behind the Scenes + +THOS is designed to run on a minimalistic Linux distro with kiosk capabilities. It ties together: + +* Firefox in kiosk mode +* Local server logic for user interaction +* Persistent configuration for headless reboots + +## 📄 License + +This project is licensed under the **Apache 2.0 License**. See the [LICENSE](LICENSE) file for details. + +--- + +## 🫶 Credits + +THOS Server is a project by [Surillyacom Entertainment](https://surillya.com/), powered by hours of work and caffeine! \ No newline at end of file diff --git a/index.php b/index.php index 48f4d89..2d13dc4 100644 --- a/index.php +++ b/index.php @@ -408,7 +408,7 @@