https://github.com/spring/uberserver
uberserver, a matchmaking/chat lobby server for the spring rts project
https://github.com/spring/uberserver
Last synced: 10 months ago
JSON representation
uberserver, a matchmaking/chat lobby server for the spring rts project
- Host: GitHub
- URL: https://github.com/spring/uberserver
- Owner: spring
- License: other
- Created: 2013-02-17T15:18:09.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2024-11-20T20:02:19.000Z (about 1 year ago)
- Last Synced: 2025-03-31T16:18:20.484Z (11 months ago)
- Language: Python
- Homepage: https://springrts.com/wiki/Uberserver
- Size: 2.53 MB
- Stars: 33
- Watchers: 10
- Forks: 38
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project Overview
Uberserver is a lobbyserver written in python for spring lobby clients. It is currently used as the main lobby server running at lobby.springrts.com port 8200.
## Prerequisites
This project is built using Python 3. Make sure you have the following installed before proceeding:
- `Python 3`
- `SQLAlchemy`
- `GeoIP`
- `Twisted`
### System Packages Required
For Debian/Ubuntu:
- `libssl-1.0-dev`
- `libgeoip-dev`
- `libmariadbclient-dev` or `libmysqlclient-dev`
```
# apt update
# apt install libssl1.0-dev libgeoip-dev libmariadbclient-dev
```
## Installation Steps
### Option 1: Manual Installation
1. Clone the uberserver source code:
```bash
git clone git@github.com:spring/uberserver.git
```
2. Create a Python virtual environment:
```bash
virtualenv ~/virtenvs/uberserver
source ~/virtenvs/uberserver/bin/activate
```
3. Install Python dependencies:
```bash
pip install -r requirements.txt
```
4. SQLite is used by default. For production, consider setting up MySQL or PostgreSQL.
### Option 2: Using Docker for Local Server
1. Build and run the local server:
```bash
cd docker
docker-compose build
docker-compose up
```
2. To find the container ID:
```bash
docker ps
```
3. Access the database and add users:
```bash
docker exec -it your_container_id bash
sqlite3 local_server.db
```
4. Use the following command to log in:
```bash
docker logs your_container_id
```
The address will look like "private: 192.168.100.17:8200". Use it to log in with `user1/123`.
## Usage
Activate the virtual environment and start the server:
```bash
source ~/virtenvs/uberserver/bin/activate
./server.py
```
## Logs
- Log file: `$PWD/server.log`
## External Documents
Refer to https://springrts.com/wiki/Uberserver for more details.
## Help and Support
For any issues or questions, refer to the server logs or Docker logs. You can also raise issues on the [GitHub Repository](https://github.com/spring/uberserver).