Skip to content

Commit

Permalink
Add help in config file; bump readme instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Philipp Heckel committed Sep 3, 2021
1 parent 4ba798d commit 2d2a1b2
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,14 +174,14 @@ sudo apt install replbot
**Debian/Ubuntu** (*manual install*)**:**
```bash
sudo apt install tmux
wget https://github.com/binwiederhier/replbot/releases/download/v0.4.2/replbot_0.4.2_amd64.deb
dpkg -i replbot_0.4.2_amd64.deb
wget https://github.com/binwiederhier/replbot/releases/download/v0.4.5/replbot_0.4.5_amd64.deb
dpkg -i replbot_0.4.5_amd64.deb
```

**Fedora/RHEL/CentOS:**
```bash
# Make sure that "tmux" is installed
rpm -ivh https://github.com/binwiederhier/replbot/releases/download/v0.4.2/replbot_0.4.2_amd64.rpm
rpm -ivh https://github.com/binwiederhier/replbot/releases/download/v0.4.5/replbot_0.4.5_amd64.rpm
```

**Docker:**
Expand All @@ -206,8 +206,8 @@ go get -u heckel.io/replbot
**Manual install** (*any x86_64-based Linux*)**:**
```bash
# Make sure that "tmux" is installed
wget https://github.com/binwiederhier/replbot/releases/download/v0.4.2/replbot_0.4.2_linux_x86_64.tar.gz
sudo tar -C /usr/bin -zxf replbot_0.4.2_linux_x86_64.tar.gz replbot
wget https://github.com/binwiederhier/replbot/releases/download/v0.4.5/replbot_0.4.5_linux_x86_64.tar.gz
sudo tar -C /usr/bin -zxf replbot_0.4.5_linux_x86_64.tar.gz replbot
```

## Building
Expand Down
13 changes: 13 additions & 0 deletions config/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,20 @@ bot-token: MUST_BE_SET
#
# idle-timeout: 10m

# Defines the maximum number of active sessions by all users combined.
#
# Format: <number>
# Default: 6
# Required: No
#
# max-total-sessions: 6

# Defines the maximum number of active sessions by any individual user.
#
# Format: <number>
# Default: 2
# Required: No
#
# max-user-sessions: 2

# Cursor setting for the terminal. Can be "on" to always render the cursor, "off" to turn it off entirely,
Expand Down

0 comments on commit 2d2a1b2

Please sign in to comment.