https://github.com/kumassy/ownserver
Expose your local game server to the Internet.
https://github.com/kumassy/ownserver
factorio factorio-server minecraft minecraft-server ngrok rust rust-lang
Last synced: 3 months ago
JSON representation
Expose your local game server to the Internet.
- Host: GitHub
- URL: https://github.com/kumassy/ownserver
- Owner: Kumassy
- Created: 2021-05-27T12:53:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-31T11:39:56.000Z (4 months ago)
- Last Synced: 2025-10-10T03:26:13.577Z (3 months ago)
- Topics: factorio, factorio-server, minecraft, minecraft-server, ngrok, rust, rust-lang
- Language: Rust
- Homepage:
- Size: 1.42 MB
- Stars: 56
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# OwnServer
Expose your local game server to the Internet.
This software aims to minimize cost and effort to prepare local game server like Minecraft, Factorio, RUST and so on.
- Cost you'll save
- You can utilize any redundunt compute resource for game server as long as they can connect *to* the Internet.
- You can save cost for Cloud, VPS.
- Effort you'll save
- No firewall, NAT settings is required.
- [GUI application](https://github.com/Kumassy/ownserver-client-gui) is also available.
## Features
- Expose your local TCP/UDP endpoint to the Internet
- Offer GUI client for game server for Minecraft, factorio, RUST, etc.
## Installation
### Recommended
install it by [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
```sh
cargo install ownserver
```
If you dont have cargo installed, please install [rustup](https://rustup.rs/) beforehand
### Download binary
Download binary for your OS:
https://github.com/Kumassy/ownserver/releases
### cargo build
Optionally, you can build ownserver by yourself:
```sh
git clone https://github.com/Kumassy/ownserver.git
cd ownserver
cargo build --release
```
## Usage
:warning: This software has not yet reach stable release. Use with caution! :warning:
We also offer GUI. visit [ownserver-client-gui](https://github.com/Kumassy/ownserver-client-gui)
```sh
% ownserver -h
Expose your local game server to the Internet
Usage: ownserver [OPTIONS] --endpoint
Options:
--endpoint
Port and protocol of your local game server e.g.) `25565/tcp` for Minecraft
--api-port
Advanced settings. You can inspect client's internal state at localhost:.
--control-port
Advanced settings [default: 5000]
--token-server
Advanced settings [default: https://auth.ownserver.kumassy.com/v2/request_token]
--periodic-ping-interval
[default: 15]
-h, --help
Print help
-V, --version
# listen on local port
% nc -kl 3000
% ownserver --endpoint 3010/tcp
Your Client ID: client_17638595-be9d-41b9-89bf-c678c1e98d10
Endpoint Info:
+------------------------------------------------------------------------+
| tcp://localhost:3010 <--> tcp://shard-2509.ownserver.kumassy.com:15335 |
+------------------------------------------------------------------------+
# you can send any TCP packet to local port!
% nc shard-7924.ownserver.kumassy.com 17974
hello
```
via cargo
```sh
% cargo run --release --bin ownserver -- -h
```
### Run Minecraft Server
```sh
# run minecraft server
java -Xmx1024M -Xms1024M -jar server.jar nogui
# run ownserver client
ownserver -- --endpoint 25565/tcp
```
share your public URL!
### Use the client API to inspect endpoints and streams
You can query endpoints and streams info using the client API.
You need to specify local port to use the API:
```
% ownserver --endpoint 25565/tcp --api-port 9000
% curl -s localhost:9000/endpoints
[[{"id":"02291214-8647-4d08-ace3-032ac255bb14","protocol":"TCP","local_port":3010,"remote_port":19083}]]
% curl -s localhost:9000/streams
[{"stream_id":"5768354e-97c9-4c6a-8cd2-8163a1f3621c","remote_info":{"remote_peer_addr":"x.x.x.x:13367"}}]
```
## How it works
This app creates a private tunnel between our server and your local game server. You'll get a dedicated global public address for your server.
All requests to that public address are forwarded to your local game server throught the tunnel.
## Similer Project
- [ngrok](https://github.com/inconshreveable/ngrok)
- written in Go
- support HTTP, HTTPS and TCP
- [tunnelto](https://github.com/agrinman/tunnelto)
- written in Rust
- support HTTP
This software was initially developed as a fork of [tunnelto](https://github.com/agrinman/tunnelto).
## Contributing
For a guided tour of the codebase and local development instructions see [docs/development_overview.md](docs/development_overview.md).
### Project Layout
- ownserver/ownserver
- include executable of client application
- also serves library for ownserver-client-gui
- ownserver/ownserver_lib
- define transmission protocol between client and server
- ownserver/ownserver_server
- establish private tunnel to client
- forward request between public endpoints to a set of client
- [ownserver-auth](https://github.com/Kumassy/ownserver-auth)
- performs user authentication and load balancing
- [ownserver-client-gui](https://github.com/Kumassy/ownserver-client-gui)
- GUI for ownserver client
## Running tests
```sh
cargo test
```
### Self-hosting
You need to deploy [ownserver-auth](https://github.com/Kumassy/ownserver-auth).
It issues token to ownserver client.
At first, run ownserver-auth as follows:
```sh
cd ownserver-auth/
cargo run -- --token-secret supersecret --hosts localhost
```
- generate secure string for `--token-secret`.
- This is a secret shared between `ownserver-auth` and `ownserver-server`.
- `ownserver_server` verifies the signature based on `--token-secret` to ensure that the token is legitimate.
- `--hosts` is a list of hostname of `ownserver_server`.
- If you deploy multiple `ownserver_server`, list hostname of `ownserver_server` separated by commas.
Then, run `ownserver_server`:
```sh
cd ownserver/
cargo run --bin ownserver-server -- --host localhost --remote-port-start 20000 --remote-port-end 30000 --log-file ./ownserver-server.log --token-secret supersecret
```
- `--host` is the hostname for running `ownserver_server`.
- Remote ports are selected between `--remote-port-start` and `--remote-port-end`
- `--log-file` is the location of the `ownserver-server` log file
- `--token-secret` is the shared secret between `ownserver-auth` and `ownserver_server`.
Now, `ownserver-server` can accept request from `ownserver-client`:
```sh
cargo run --bin ownserver -- --payload tcp --local-port 3000 --token-server http://localhost:8123/v0/request_token
```
- You should specify `--token-server` to ensure `ownserver-client` uses your local `ownserver-auth`.
### Issue/PR
Feel free to open Issues, send Pull Requests!
### License
MIT