Skip to content

Commit

Permalink
chore: update docs for install
Browse files Browse the repository at this point in the history
  • Loading branch information
lukepolo committed Oct 25, 2024
1 parent 96451ce commit b372101
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 19 deletions.
4 changes: 2 additions & 2 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ export default defineConfig({
text: "Install",
link: "/install",
items: [
{ text: "What is Installed?", link: "/install/what-is-installed" },
{ text: "Requirements", link: "/install/requirements" },
{
text: "Configuration Options",
link: "/install/command-line-arguments",
},
{ text: "Updating", link: "/install/updating" },
{ text: "Nginx Configuration", link: "/install/nginx" },
{ text: "Tailscale Integration", link: "/install/tailscale" },
{ text: "Whats Installed?", link: "/install/what-is-installed" },
],
},
{ text: "Updating", link: "/install/updating" },
],
},
{
Expand Down
2 changes: 2 additions & 0 deletions discord-bot/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# 5Stack Discord Bot

40 changes: 26 additions & 14 deletions install/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
::: danger
Please ensure you have met the [Requirements](/install/requirements) before you begin installing the 5Stack Panel.
:::

# Installation

The [5Stack-Panel](https://github.com/5stackgg/5stack-panel) repostiory includes scirpts to help facilityte the installation process.
Expand All @@ -10,22 +6,38 @@ The [5Stack-Panel](https://github.com/5stackgg/5stack-panel) repostiory includes
git clone https://github.com/5stackgg/5stack-panel
```

::: danger
Please ensure you have met the [Requirements](/install/requirements) before you begin installing the 5Stack Panel.
:::

## Running the Installation Script

Inside the 5Stack-Panel directory, run the installation script with `sudo` priviliges, `./install.sh`.

After running the installation script, there are additonal steps required to complete the installation.
After running the installation script, there are additional steps required to complete the installation. Please refer to the [Post Installation](#post-installation) section for more details.

In the folders `INSTALL_DIR/base/properties` and `INSTALL_DIR/base/secrets`, you will find the `env` files. Go through each file and populate the variables with your desired values. You should then run the `./update.sh` script`.
## Post Installation

::: warning
We are actively working on improving the installation process. For now, it's crucial to carefully review and configure each file to ensure the setup is correct.
:::
You will need to set up additional environment variables located in the `INSTALL_DIR/base/properties` and `INSTALL_DIR/base/secrets` folders.

## Updating
## Api Config
Located in `INSTALL_DIR/base/properties/api.env`, update the domains and ensure your DNS points to the 5Stack Panel.

After the first install you should run the `./update.sh` script
Additionally, there are Tailscale environment variables that need to be set. The .env file should contain links directing you to where you can obtain these variables.

::: info
Additional arguments can be passed to modify how the panel operates. For more details, please refer to the [Command Line Arguments](/install/command-line-arguments) page.
:::
## S3 Setup
5Stack includes a built-in S3-compatible object storage system.

### S3 console host
Located in `INSTALL_DIR/base/properties/s3.env`, update the domain for the S3 console host. Ensure that your DNS is configured to point this domain to the 5Stack Panel.

#### S3 Bucket Setup

Located in `INSTALL_DIR/base/secrets/s3-secrets.env`, you will need to create a new bucket and generate an access key and secret key.

You can obtain the access key and secret key by accessing your `S3_CONSOLE_HOST`, which should have been set up in the previous step.
Log in using the credentials found in `INSTALL_DIR/base/secrets/minio-secrets.env`.


## Steam Api Key Secret
Located in `INSTALL_DIR/base/secrets/steam-secrets.env`, update the `STEAM_WEB_API_KEY`. You can obtain this key from the [Steam Developer Portal](https://steamcommunity.com/dev/apikey).
7 changes: 4 additions & 3 deletions install/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ The 5Stack Panel operates on [K3s](https://docs.k3s.io/installation/requirements

Before proceeding, please ensure that you meet all the requirements for K3s installation.

## Port 80 and 443

The 5Stack Panel requires port 80 and 443 to be open and accessible, if that is not possible you can modify the [Nginx configuration](/install/nginx) to use different ports.
1. Domain
The 5Stack Panel requires a domain name to be configured. You will need to be able to point multiple subdomains to the 5Stack Panel.
2. Port 80 and 443
The 5Stack Panel requires port 80 and 443 to be open and accessible, if that is not possible you can modify the [Nginx configuration](/install/nginx) to use different ports.

0 comments on commit b372101

Please sign in to comment.