Skip to content
This repository was archived by the owner on Feb 28, 2024. It is now read-only.

Commit 3f51c73

Browse files
committed
Updated README.md
1 parent 51a174a commit 3f51c73

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

README.md

+48-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,54 @@ Surftimer-Web-Stats is Official Web with statistics for [Surftimer-Official](htt
2525
* [Master Demo](https://demo.stats.surftimer.dev/)
2626
* [Develop Demo](https://dev.stats.surftimer.dev/)
2727

28-
## Wiki & Installation Guide
28+
## Installation and Requirements
29+
30+
Surftimer-Web-Stats works on latest Release of [Surftimer-Official](https://github.com/surftimer/Surftimer-Official). (May be problems on Pre-Release versions).
31+
32+
#### General Requirements
33+
* Maps must have selected tier and be added to server with sm_addnewmap(!addnewmap) command on server
34+
* A MySQL Database with [Surftimer-Official](https://github.com/surftimer/Surftimer-Official) data (MySQL 5.7, MySQL 8+, MariaDB supported)
35+
* DB user with permissions to SELECT, ALTER TABLE, UPDATE AND INSERT.
36+
37+
### Docker (Recommended)
38+
#### Requirements
39+
* [Docker](https://docs.docker.com/get-docker/)
40+
41+
#### Installation
42+
Start by pulling docker image
43+
##### Docker Hub Packages
44+
`docker pull kristianp26/surftimer-web-stats:latest`
45+
##### Github Packages
46+
`docker pull ghcr.io/surftimer/surftimer-web-stats:latest`
47+
48+
Next step: Run Docker container
49+
50+
```
51+
docker run -d \
52+
-e DB_HOST=database_host \
53+
-e DB_PORT=database_port \
54+
-e DB_USER=database_user \
55+
-e DB_PASS=database_pass \
56+
-e DB_NAME=database_name \
57+
-e "NAVBAR_TITLE=My Surf Server" \
58+
-p 8080:80 \
59+
kristianp26/surftimer-web-stats:latest
60+
```
61+
### Standalone
62+
#### Requirements
63+
64+
* Web Server
65+
* PHP 8+ (PHP extensions: mysqli, bcmath)
66+
67+
#### Installation
68+
69+
* Download the latest version from the release page [here](https://github.com/KristianP26/Surftimer-Web-Stats/releases)
70+
* Copy unziped files into your website directory
71+
* Edit `/inc/config.php`
72+
73+
You can find more info on wiki page: [Installation Guide](https://github.com/surftimer/SurfTimer-Web-Stats/wiki/Installation)
74+
75+
## Wiki
2976

3077
**[Wiki & Installation Guide](https://github.com/surftimer/SurfTimer-Web-Stats/wiki)**
3178

0 commit comments

Comments
 (0)