Skip to content

Commit b74d5f1

Browse files
committed
Update Readme
1 parent 8bcb9fb commit b74d5f1

File tree

1 file changed

+1
-125
lines changed

1 file changed

+1
-125
lines changed

README.md

Lines changed: 1 addition & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -47,131 +47,7 @@ Compatible with all librespeed clients :
4747
- Copy `setup_systemd.sh` on linux or `setup_sc_win.bat` on windows system in extracted folder.
4848
- Run the script file to setup as service
4949

50-
### Build with docker
51-
52-
1. Install docker and docker-compose.
53-
54-
2. Clone the repository:
55-
56-
```sh
57-
$ git clone https://github.com/librespeed/speedtest-rust.git
58-
$ cd speedtest-rust
59-
```
60-
61-
3. Copy the default config and assets:
62-
63-
```sh
64-
$ cp docker-compose.override.sample.yml docker-compose.override.yml
65-
$ sudo mkdir /var/lib/librespeed
66-
$ sudo cp configs.toml /etc/librespeed.toml
67-
$ sudo cp -r assets /var/lib/librespeed/assets
68-
```
69-
70-
4. Edit the config files:
71-
72-
```sh
73-
$ sudo chmod o-rwx /etc/librespeed.toml docker-compose.override.yml # Hide secrets
74-
$ $EDITOR docker-compose.override.yml # Docker settings
75-
$ sudo $EDITOR /etc/librespeed.toml # Librespeed settings
76-
$ sudo $EDITOR /var/lib/librespeed/assets/servers_list.js # To set server name and remote servers
77-
$ sudo $EDITOR /var/lib/librespeed/assets/index.html # To change html styles, etc
78-
```
79-
80-
5. Start the container:
81-
82-
```sh
83-
$ docker compose up -d
84-
$ docker compose logs -f # To check status
85-
```
86-
87-
6. Navigate to http://localhost:8080/
88-
89-
### Compile from source
90-
91-
> You need Rust **1.74+** to compile project.\
92-
> So make sure that rust is properly installed on your system
93-
94-
1. Clone the repository:
95-
96-
```
97-
$ git clone https://github.com/librespeed/speedtest-rust.git
98-
```
99-
100-
2. Build:
101-
102-
```
103-
# cd to cloned directory
104-
$ cargo build --release
105-
```
106-
107-
3. Prepare files:
108-
109-
```
110-
# Make a new directory
111-
# Copy target/release/librespeed-rs to created directory
112-
# Copy configs.toml to created directory
113-
# If you want the server to load the speedtest web front in the route `/`,
114-
then you must specify the path of the client folder in the configs.toml file.
115-
```
116-
117-
4. Change `configs.toml` according to your environment:
118-
119-
```toml
120-
# bind socket adress
121-
bind_address="0.0.0.0"
122-
# socket listent port, default is 8080
123-
listen_port=8080
124-
125-
# you can specify the number of worker threads. default is 1
126-
# auto: number of cpu cores, or more than 0 as desired
127-
# increasing the count increases memory usage
128-
worker_threads=1
129-
130-
# base api url /{base_url}/routes
131-
base_url="backend"
132-
133-
# ipinfo.io API key, If the api-key works, the priority is with the api, if not with the offline database
134-
ipinfo_api_key=""
135-
136-
# set directory of speedtest web front to server load on `/`. If it is empty, default web will be returned
137-
assets_path="./assets" # Write without suffix separator
138-
139-
# password for logging into statistics page, fill this to enable stats page
140-
stats_password=""
141-
142-
# redact IP addresses
143-
redact_ip_addresses=false
144-
145-
# set telemetry result image theme : light, dark
146-
# default is light
147-
result_image_theme="light"
148-
149-
# database config for : mysql, postgres, sqlite, memory, or disable by write none
150-
# after restarting the service, the in-memory database is reset
151-
# if none is specified, no telemetry/stats will be recorded, and no result JPG will be generated
152-
database_type="sqlite"
153-
database_hostname="localhost"
154-
database_name="speedtest_db"
155-
database_username=""
156-
database_password=""
157-
# if you use `sqlite` as database, set database_file to database file location
158-
database_file="speedtest.db"
159-
160-
# enable and use TLS option; if enable it, you need to prepare certificates and private keys
161-
enable_tls=false
162-
tls_cert_file=""
163-
tls_key_file=""
164-
```
165-
166-
## ISP Detection
167-
168-
- This project use offline database for detect ip ISPs
169-
- Currently, only the ipinfo.io database is supported
170-
- You can download or update database automatically by typing :
171-
172-
```
173-
$ librespeed-rs --update-ipdb
174-
```
50+
[Read full installation methods in wiki](https://github.com/librespeed/speedtest-rust/wiki/Installation)
17551

17652
## Note :
17753
This project can be much better.\

0 commit comments

Comments
 (0)