Froxlor/README.md

77 lines
2.6 KiB
Markdown
Raw Normal View History

[![Froxlor-CI](https://github.com/Froxlor/Froxlor/actions/workflows/build-mariadb.yml/badge.svg?branch=main)](https://github.com/Froxlor/Froxlor/actions/workflows/build-mariadb.yml)
[![Froxlor-CI](https://github.com/Froxlor/Froxlor/actions/workflows/build-mysql.yml/badge.svg?branch=main)](https://github.com/Froxlor/Froxlor/actions/workflows/build-mysql.yml)
2022-01-02 13:53:59 +00:00
[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.froxlor.org)
2018-02-27 07:50:54 +00:00
2013-12-03 13:47:17 +00:00
# Froxlor
The server administration software for your needs.
Developed by experienced server administrators, this panel simplifies the effort of managing your hosting platform.
## Installation
### Fast install
1. Ensure that your webserver serves /var/www/html
2. Extract froxlor into /var/www/html
2013-12-03 13:47:17 +00:00
3. Point your browser to http://[ip-of-webserver]/froxlor
4. Follow the installer
5. Login as administrator
6. Have fun!
If you have chosen to do the configuration by hand during the installation, you have to complete some more steps:
1. Adjust "System > Settings" according to your needs
2. Choose your distribution under "System > Configuration"
3. Follow the steps for your services
2013-12-03 13:47:17 +00:00
### Detailed installation
https://docs.froxlor.org/latest/general/installation/
2013-12-03 13:47:17 +00:00
## Help
You may find help in the following places:
2022-01-02 13:35:36 +00:00
### Discord
2022-01-02 13:53:59 +00:00
The froxlor community discord server can be found here: https://discord.froxlor.org
2022-01-02 13:35:36 +00:00
2013-12-03 13:47:17 +00:00
### Forum
The community is located on https://forum.froxlor.org/
2013-12-03 13:47:17 +00:00
### Documentation
2013-12-03 13:47:17 +00:00
The documentation may be found at https://docs.froxlor.org/
2013-12-03 13:47:17 +00:00
## License
May be found in [COPYING](COPYING)
2013-12-03 13:47:17 +00:00
## Downloads
### Tarball
https://files.froxlor.org/releases/froxlor-latest.tar.gz [MD5](https://files.froxlor.org/releases/froxlor-latest.tar.gz.md5) [SHA1](https://files.froxlor.org/releases/froxlor-latest.tar.gz.sha1)
2013-12-03 13:47:17 +00:00
2023-01-24 17:56:29 +00:00
### Debian / Ubuntu repository
2013-12-03 13:47:17 +00:00
[HowTo](https://docs.froxlor.org/latest/general/installation/apt-package.html)
2013-12-03 13:47:17 +00:00
#### Debian
2020-01-02 12:53:22 +00:00
```
apt -y install apt-transport-https lsb-release ca-certificates curl gnupg
curl -sSLo /usr/share/keyrings/deb.froxlor.org-froxlor.gpg https://deb.froxlor.org/froxlor.gpg
sh -c 'echo "deb [signed-by=/usr/share/keyrings/deb.froxlor.org-froxlor.gpg] https://deb.froxlor.org/debian $(lsb_release -sc) main" > /etc/apt/sources.list.d/froxlor.list'
2020-01-02 12:53:22 +00:00
```
2013-12-03 13:47:17 +00:00
#### Ubuntu
2013-12-03 13:47:17 +00:00
2020-01-02 12:53:22 +00:00
```
apt -y install apt-transport-https lsb-release ca-certificates curl gnupg
curl -sSLo /usr/share/keyrings/deb.froxlor.org-froxlor.gpg https://deb.froxlor.org/froxlor.gpg
sh -c 'echo "deb [signed-by=/usr/share/keyrings/deb.froxlor.org-froxlor.gpg] https://deb.froxlor.org/ubuntu $(lsb_release -sc) main" > /etc/apt/sources.list.d/froxlor.list'
2020-01-02 12:53:22 +00:00
```
2017-04-13 14:38:17 +00:00
## Contributing
[see here](.github/CONTRIBUTING.md)