helsby-studios / perros

PerrOS - The operating system for your discord server.

PerrOS

PerrOS is a Opensource Discord Bot to do it all!

Installation

Manual installation

Use the package manager pip to install the python3 requirements.

pip3 install -r requirements.txt --no-deps

Then run main.py.

python3 main.py

Go to the IP adress show in the Console and finish the Web-Setup. More information can be found in our wiki.

_{Note that PerrOS is designed to work on Linux especially Ubuntu Server, it might work any other os too but its not recomended}

Dockerized installation

Install PerrOS in a docker container.

Automated

To perform an automated install (recommended for beginners) you can use the following commands:

chmod +x dockerized.sh
sudo ./dockerized.sh

After editing the config file you can enjoy PerrOS on port 80 and finish the web setup.

To uninstall PerrOS you can use the following commands:

chmod +x ./uninstall-dockerized.sh
sudo ./uninstall-dockerized.sh

Manual

To perform a manual install you can use the following commands:

docker build -t perros .
docker run -p 80:80 -v perros-data:/app -d perros

Alternative commands:

docker build -t perros .
docker run --network="host" -p 80:80 -v /path/to/folder:/app -d perros

To uninstall PerrOS you can use the following commands:

docker stop perros
docker rm -f perros
docker volume remove prerros-data

Usage

To dump the Volumes of PerrOS you can use the following commands:

docker cp perros:/app .
docker cp . perros:/app

Coming Soon

Contributing

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

Please make sure to update tests as appropriate.

For more detailed guidelines please read our wiki

License

PerrOS is licensed under GPLV3

If anyone is crazy enough to donate to a random developer in Europe, heres my ETH address: 0x1Eb4317add0E70873A88F36987b0003d8830D87D