Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wiibleyde/hathermos

End of first year project. (Ynov Informatique)
https://github.com/wiibleyde/hathermos

aternos css docker dockercompose html minecraft minecraft-server python tailwind-css tailwindcss vanilla

Last synced: 6 days ago
JSON representation

End of first year project. (Ynov Informatique)

Awesome Lists containing this project

README

        

# HaThermos

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4af34b6cf53e414b92851d98d49566b1)](https://app.codacy.com/gh/Wiibleyde/HaThermos/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) ![Release](https://img.shields.io/github/v/release/Wiibleyde/HaThermos) ![License](https://img.shields.io/github/license/Wiibleyde/HaThermos)

## Description

HaThermos is a simple parodies of the famous [Aternos](https://aternos.org/) website. It is a web application that allows you to create a Minecraft server in a few clicks. It is a project that I started to learn the basics of web development. It is not intended to be used in production (but it is possible).

In my deployment of HaThermos, I use the following technologies:

- [UptimeRobot](https://stats.uptimerobot.com/ykNNQINRVP) to monitor the server status
- [Netdata](https://maison.bonnell.fr/netdata/#after=-1020;before=0;;theme=slate;utc=Europe%2FParis) to monitor the server resources

## Features

- Create a Vanilla Minecraft server in a few clicks

## Installation and start

Simply clone the repository and run the following command:

```bash
docker-compose up -d
```

And that's it, you can now access the application at the following address: `http://localhost:8090/`

## Manage HaThermos

### See the logs the web server

To see the logs of a server, you must go on your server in the `/var/hathermos/hathermos-data/` directory. You will then have to open the `logs.log` file.

### Modify the database

To modify the database, you must go on your server in the `/var/hathermos/hathermos-data/` directory. You will then have to open the `database.db` file.

### Get the minecraft servers data

To get the minecraft servers data, you must go on your server in the `/var/hathermos/minecraft-data/` directory. You will see some folder named has the id of the server. In each folder, you will have the minecraft server data.

### Get the backups of the minecraft servers and the HaThermos data

To get the backups of the minecraft servers and the HaThermos data, you must go on your server in the `/var/hathermos/hathermos-backup/` directory. You will see some folder named has the date, the hour and the minute of the backup. In each folder, you will have the `minecraft` folder and the `data` folder. The `minecraft` folder contains the minecraft server data and the `data` folder contains the HaThermos data.

#### **Send backup to another server**

You can use the following script :

```bash
#!/bin/bash

latest=$(ls -t /var/hathermos/hathermos-backup | head -1)
scp /var/hathermos/hathermos-backup/$latest {user}@{ip}:{path}
```

#### **Restore backup**

To restore the latest backup, you can use this scrpt :
```bash
#!/bin/bash
cd /var/hathermos/hathermos-backup/
latest=$(ls -t /var/hathermos/hathermos-backup | head -1)
tar -xzf $latest.tar.gz
cp -r hathermos-data /var/hathermos/hathermos-data
cp -r minecraft-data /var/hathermos/minecraft-data
```
And to restore a specific backup :
```bash
#!/bin/bash

cd /var/hathermos/hathermos-backup/
tar -xzf {backup}.tar.gz
cp -r hathermos-data /var/hathermos/hathermos-data
cp -r minecraft-data /var/hathermos/minecraft-data
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## Author

- **Wiibleyde, Gwuill, Sml_Dreams** - _Initial work_ - [Wiibleyde](https://github.com/wiibleyde), [Gwuill](https://github.com/Gwuill33), [Sml_Dreams](https://github.com/SmlDreams)
- **Aternos** - _Inspiration_ - [Aternos](https://aternos.org/)
- **itzg** - _Docker Minecraft server_ - [itzg](https://github.com/itzg/docker-minecraft-server)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

## Acknowledgments

- [Aternos](https://aternos.org/)
- [itzg](https://github.com/itzg/docker-minecraft-server)