Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BadApple9 authored Dec 14, 2022
1 parent 6cae2ee commit 71e56ab
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,34 +20,36 @@ speedtest-x uses file datebase to save speedtest results from various users. Thu

## Quick start

#### <img src='https://img.icons8.com/fluency/512/docker.png' width="10%"></img>Deploy by Docker (Supported platforms: AMD64/ARM64)
1. Pull [Image](https://hub.docker.com/r/badapple9/speedtest-x) `docker pull badapple9/speedtest-x`
2. Run container `docker run -d -p 9001:80 -it badapple9/speedtest-x`

Optional arguments:

> **-e MAX_LOG_COUNT=100**: Maximum results size, 100 by default
#### <img src='https://img.icons8.com/fluency/512/docker.png' width="2%"></img> Deploy by Docker (Supported platforms: AMD64/ARM64)
> 1. Pull [Image](https://hub.docker.com/r/badapple9/speedtest-x) `docker pull badapple9/speedtest-x`
> 2. Run container `docker run -d -p 9001:80 -it badapple9/speedtest-x`
>
> **-e IP_SERVICE=ip.sb**: IP info provider (Options: ip.sb / ipinfo.io), ip.sb by default
>> Optional arguments:
>>
>>> **-e MAX_LOG_COUNT=100**: Maximum results size, 100 by default
>>>
>>> **-e IP_SERVICE=ip.sb**: IP info provider (Options: ip.sb / ipinfo.io), ip.sb by default
>>>
>>> **-e SAME_IP_MULTI_LOGS=false**: Whether to allow the same user IP to record multiple speedtest results, false by default.
>>
>> If you want support IPV6 in a Docker container, edit `/etc/docker/daemon.json`:
>>> ```
>>> {
>>> "ipv6": true,
>>> "fixed-cidr-v6": "fd00::/80",
>>> "experimental": true,
>>> "ip6tables": true
>>> }
>>> ```
>
> **-e SAME_IP_MULTI_LOGS=false**: Whether to allow the same user IP to record multiple speedtest results, false by default.
> If you want support IPV6 in a Docker container, edit `/etc/docker/daemon.json`:
> ```
> {
> "ipv6": true,
> "fixed-cidr-v6": "fd00::/80",
> "experimental": true,
> "ip6tables": true
> }
> ```
>3. Open `{your_ip}:9001`
3. Open `{your_ip}:9001`
-------
#### General deploy (Require: PHP5.6+)
#### <img src='https://img.icons8.com/dusk/512/php.png' width="2%"></img> General deploy (Require: PHP5.6+)
1. Download repository files and unzip to website directory, open `{your_domain_name}/index.html`.
2. Open `{your_domain_name}/results.html` to check out speedtest result datasheet.
>1. Download repository files and unzip to website directory, open `{your_domain_name}/index.html`.
>2. Open `{your_domain_name}/results.html` to check out speedtest result datasheet.
## Settings
Expand Down

0 comments on commit 71e56ab

Please sign in to comment.