Skip to content

Commit

Permalink
replace missing icons
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Kaufmann <d00p@froxlor.org>
  • Loading branch information
d00p committed Nov 11, 2023
1 parent 32bf3a0 commit 092e1e2
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions general/quick-start-guide/index.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
# Quick Start Guide

In this tutorial we will create a simple froxlor installation, i.e. a single host installation with everything running on a single Linux machine.
In this tutorial we will create a simple froxlor installation, i.e. a single host installation with everything running
on a single Linux machine.

* Apache 2.4 with PHP-FPM and MariaDB
* ProFTPd as FTP server
* Postfix and Dovecot as mail server
* Automatic SSL certificates with Let's Encrypt

If you want to deviate from the default installation, you can customize the installation with the Advanced Options described below.
If you want to deviate from the default installation, you can customize the installation with the Advanced Options
described below.

## Supported platforms

froxlor provides packages from the following Linux distributions and architectures:

| Platform | x86_64 / amd64 |
|----------|----------------------------------------------------------------------|
| Ubuntu | <span class="text-success"><i class="fa fa-circle-check"></i></span> |
| Debian | <span class="text-success"><i class="fa fa-circle-check"></i></span> |
| Gentoo | check our documentation |
| Platform | x86_64 / amd64 |
|----------|----------------|
| Ubuntu ||
| Debian ||

## Starting the froxlor installation

Expand All @@ -27,15 +28,17 @@ Everything you need for froxlor can be installed with one command:
$ curl -fsSL https://get.froxlor.org | bash
```

Within a few minutes the installation is completed and the passwords for the database and the admin portal are displayed in the CLI.
Within a few minutes the installation is completed and the passwords for the database and the admin portal are displayed
in the CLI.

Please **note** the passwords, as they will not be displayed later.

The installation is now complete and all services are configured.

#### Optional: Advanced options

If you want to install other services than the default installation, you can add more arguments to the above command. Please note that you must do this before the first installation.
If you want to install other services than the default installation, you can add more arguments to the above command.
Please note that you must do this before the first installation.

| Service | Flag | Default | Description |
|------------|--------------------------------|----------|---------------------------------------------------------------|
Expand All @@ -48,7 +51,8 @@ If you want to install other services than the default installation, you can add
| IPV6 | --ipv6=xxxx:xxxx:xxxx:xxxx::x | DNS | This should be set the public IPv6 |
| Unattended | --unattended | | This should skip all prompts as long as all variables are set |

The command then looks like this, notice the two dashes (--) which are telling bash to not process anything following it as arguments to bash:
The command then looks like this, notice the two dashes (--) which are telling bash to not process anything following it
as arguments to bash:

```shell
$ curl -fsSL https://get.froxlor.org | bash -s -- --unattended
Expand All @@ -62,4 +66,8 @@ On the following pages you will find more information about installation, commis
* use another operating system

## Need help?
If you run into any problems or have difficulties understanding / setting-up / whatever - don't hesitate to contact us either via e-mail ([team@froxlor.org](mailto:team@froxlor.org)) or the preferred way: on Discord ([https://discord.froxlor.org](https://discord.froxlor.org)) and our forums ([https://forum.froxlor.org/](https://forum.froxlor.org/))

If you run into any problems or have difficulties understanding / setting-up / whatever - don't hesitate to contact us
either via e-mail ([team@froxlor.org](mailto:team@froxlor.org)) or the preferred way: on
Discord ([https://discord.froxlor.org](https://discord.froxlor.org)) and our
forums ([https://forum.froxlor.org/](https://forum.froxlor.org/))

0 comments on commit 092e1e2

Please sign in to comment.