Skip to content

Commit

Permalink
Updating README.md with some minor changes for improved clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
igor-borisoglebski committed Dec 7, 2023
1 parent 360e4c1 commit f64af53
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
<p align="center">
<picture>
<img alt="Lobby" title="Lobby" src="docs/content/assets/img/lobbyGopherLogo.png">
</picture>
</p>

**Lobby** is a simple, yet highly performant, load balancer based on Linux [nftables](https://wiki.nftables.org/wiki-nftables/) designed to run as a portable binary app on Linux systems in amd64 and arm64 architectures.
**Lobby** is a simple, yet highly performant, network load balancer based on Linux [nftables](https://wiki.nftables.org/wiki-nftables/). It is designed to run as a portable binary app on Linux systems in amd64 and arm64 architectures.

# Quick Start
Use the helper script which downloads the latest Lobby binary to your current folder and sets a sample config file.
Use the helper [script](scripts/getLobby.sh) which downloads the latest Lobby binary to your current folder and sets a sample config file:

``` bash
wget -O - https://ipbuff.com/getLobby | sh
Expand All @@ -21,23 +19,24 @@ For testing purposes it might be easier to run Lobby with the `root` user. Run L
./lobby
```

To check on how to run it as unprivileged user check [here](https://lobby.ipbuff.com/installation/#permissions).
To check on how to run it as unprivileged user check [here](https://lobby.ipbuff.com/installation/#permissions)

To edit the Lobby settings, edit the `lobby.conf` file. Configuration documentation may be found [here](https://lobby.ipbuff.com/configuration).
To edit the Lobby settings, edit the local `lobby.conf` file. Configuration documentation may be found [here](https://lobby.ipbuff.com/configuration)

A relatively extensive tutorial can also be found in the Lobby documentation. Make sure to check it for many practical examples.
A relatively extensive tutorial can also be found in the Lobby documentation. Make sure to check it for many practical examples

# Documentation
The Lobby documentation is published at [https://lobby.ipbuff.com](https://lobby.ipbuff.com).
The Lobby documentation is published at [https://lobby.ipbuff.com](https://lobby.ipbuff.com)

The documentation source is in the [./docs/src](https://github.com/ipbuff/lobby/tree/main/docs/src) directory of this repository.
The documentation source is in the [./docs/src](https://github.com/ipbuff/lobby/tree/main/docs/src) directory of this repository

# Credits
This project has been created by [Igor Borisoglebski](https://igor.borisoglebski.com).
This project has been created by [Igor Borisoglebski](https://igor.borisoglebski.com)

[Gopher Konstructor](https://quasilyte.dev/gopherkon/), created by [quasilyte](https://github.com/quasilyte/gopherkon) was used for the logo creation.
[Gopher Konstructor](https://quasilyte.dev/gopherkon/), created by [quasilyte](https://github.com/quasilyte/gopherkon) was used for the logo creation

# License
This work is licensed under [CC BY-NC-SA 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/).
This work is licensed under [CC BY-NC-SA 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/)

Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License

0 comments on commit f64af53

Please sign in to comment.