kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
007c695eaa
commit
2fb9da86fa
|
|
@ -1,6 +1,9 @@
|
|||
---
|
||||
title: librespeed
|
||||
---
|
||||
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||||
<!-- Please read the https://github.com/linuxserver/docker-librespeed/blob/master/.github/CONTRIBUTING.md -->
|
||||
|
||||
# [linuxserver/librespeed](https://github.com/linuxserver/docker-librespeed)
|
||||
|
||||
[](https://github.com/linuxserver/docker-librespeed)
|
||||
|
|
@ -30,6 +33,17 @@ The architectures supported by this image are:
|
|||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
## Application Setup
|
||||
|
||||
Access the speedtest webui at `http://SERVERIP`. The results database can be accessed at `http://SERVERIP/results/stats.php` with the password set.
|
||||
The default template used is based on `example-singleServer-full.html`. However, all templates are provided for reference at `/config/www/`. Feel free to customize `/config/www/index.html` as you like. Delete the file and restart to go back to the image default.
|
||||
|
||||
You can optionally place customized `speedtest.js` and `speedtest_worker.js` files under `/config/www` and they will supersede the defaults after a container start. Keep in mind that once you do so, they will no longer be updated. You can delete them and recreate the container to go back to the image defaults.
|
||||
|
||||
If you are setting up a mysql or postgresql database, you first need to import the tables into your database as described at the following link
|
||||
https://github.com/librespeed/speedtest/blob/master/doc.md#creating-the-database
|
||||
|
||||
To enable a custom results page set the environment variable `CUSTOM_RESULTS=true` and start (or restart) the container at least once for `/config/www/results/index.php` to be created and modify this file to your liking.
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -67,7 +81,7 @@ services:
|
|||
|
||||
### docker cli
|
||||
|
||||
```
|
||||
```bash
|
||||
docker run -d \
|
||||
--name=librespeed \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -87,7 +101,6 @@ docker run -d \
|
|||
ghcr.io/linuxserver/librespeed
|
||||
```
|
||||
|
||||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
|
@ -98,7 +111,6 @@ Docker images are configured using parameters passed at runtime (such as those a
|
|||
| :----: | --- |
|
||||
| `80` | web gui |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
|
|
@ -121,15 +133,13 @@ Docker images are configured using parameters passed at runtime (such as those a
|
|||
| :----: | --- |
|
||||
| `/config` | Contains all relevant configuration files. |
|
||||
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```
|
||||
```bash
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -140,7 +150,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
|
||||
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||
|
||||
|
||||
## User / Group Identifiers
|
||||
|
||||
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
|
|
@ -149,30 +158,17 @@ Ensure any volume directories on the host are owned by the same user you specify
|
|||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
Access the speedtest webui at `http://SERVERIP`. The results database can be accessed at `http://SERVERIP/results/stats.php` with the password set.
|
||||
The default template used is based on `example-singleServer-full.html`. However, all templates are provided for reference at `/config/www/`. Feel free to customize `/config/www/index.html` as you like. Delete the file and restart to go back to the image default.
|
||||
|
||||
You can optionally place customized `speedtest.js` and `speedtest_worker.js` files under `/config/www` and they will supersede the defaults after a container start. Keep in mind that once you do so, they will no longer be updated. You can delete them and recreate the container to go back to the image defaults.
|
||||
|
||||
If you are setting up a mysql or postgresql database, you first need to import the tables into your database as described at the following link
|
||||
https://github.com/librespeed/speedtest/blob/master/doc.md#creating-the-database
|
||||
|
||||
To enable a custom results page set the environment variable `CUSTOM_RESULTS=true` and start (or restart) the container at least once for `/config/www/results/index.php` to be created and modify this file to your liking.
|
||||
|
||||
|
||||
## Docker Mods
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=librespeed "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
||||
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue