atlas-dedicated-server/REDIS example configuration/README.md

21 lines
1.4 KiB
Markdown
Raw Normal View History

2018-12-29 18:21:40 +00:00
# Example Redis DB configuration file
This is an example Redis configuration file. It should run as-is, but you may want to verify the first two lines (`bind` and `requirepassword`) to make sure it matches your configuration.
Comment-out the `bind` line if you wish the Redis server to bind to _all_ network interfaces instead of just `127.0.0.1` (this is important if you're running your Redis database on a machine not local to all of your **Shards**).
If this machine is on a different network entirely, remember to port-forward your Redis port (TCP).
2018-12-29 18:31:32 +00:00
### Getting the Redis
2018-12-29 18:32:26 +00:00
It is advised _not to use the bundled Redis DB_ as you will lose your config file each time it's updated. Please fetch a Redis server for Windows from [this Microsoft Archive repository on GitHub](https://github.com/MicrosoftArchive/redis/releases/) (version 3.2.100 is _confirmed to work_ with ATLAS DS).
2018-12-29 18:31:32 +00:00
2018-12-29 20:50:51 +00:00
Under Linux, you probably need to just run your favourite package manager to get a copy of `redis-server`.
2018-12-29 18:31:32 +00:00
2018-12-29 18:21:40 +00:00
### Usage
Drop the file into your Redis DB installation (backup the original first) and then restart the Redis service.
##### Restarting: Windows
Type `net stop redis` followed by `net start redis` into an elevated command prompt.
##### Restarting: Linux
For __systemd__ systems, `systemctl restart redis`. Otherwise, try `service redis restart` or consult the manual for your Linux distribution.