blob: 5cf9b03fd1d671e1db048d4cb16089fa8de22f80 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
---
title: Deploying (Setup)
---
So you want to deploy your own WhirlServer? Nice! You've come to the right
place!
## With Docker
### Prerequisites
- [Docker](https://docs.docker.com/engine/install/)
### Usage
```shell
$ docker run \
> -d \
> -p 8080:80 \
> -p 6650:6650 \
> -p 5673:5673 \
> -v /var/lib/whirl:/.whirl \
> whirlsplash/whirl
```
#### Copyable
```shell
docker run -d -p 8080:80 -p 6650:6650 -p 5673:5673 -v /var/lib/whirl:/.whirl whirlsplash/whirl
```
### Notes
Your configuration file can be found in `/var/lib/whirl/`.
## With Docker Compose
### Prerequisites
- [Docker](https://docs.docker.com/compose/install/)
- [Docker Compose](https://docs.docker.com/compose/install/) (newer versions of
Docker include Docker Compose!)
### Usage
1. Create a directory, preferably in a monitorable location, `cd` into it, and
create a file named `docker-compose.yml` with the following contents:
```yml
# docker-compose.yml
version: "3.3"
services:
whirl:
ports:
- "8080:80" # API
- "6650:6650" # Distributor
- "5673:5673" # Hub
volumes:
- ./.whirl-data:/.whirl
image: whirlsplash/whirl
```
2. Execute `docker-compose up` (or `docker compose up` in later versions of
Docker).
4. Wait around five seconds, if no errors are logged; `Ctrl + C` the process.
Whirl has now generated a default configuration file for you in the
`./whirl-data/` directory, `cd` into this directory and modify the
`Config.toml` to your liking.
5. You may now `cd` back into the originally created directory and execute
`docker-compose up -d` (or `docker compose up -d` in later versions of
Docker).
### Notes
Your configuration file can be found in `./whirl-data/`.
## With a Standalone Binary (Currently only for developmental use)
1. Create a directory, preferably in a monitorable location and `cd` into it.
2. Download the latest binary release of your platform (if available) from the
Whirl [releases page](https://github.com/Whirlsplash/whirl/releases/latest).
3. Execute `whirl run distributor`
4. Wait around five seconds, if no errors are logged: `Ctrl + C` the process.
Whirl has now generated a default configuration file for you in the
`./whirl/` directory, `cd` into this directory and modify the
`Config.toml` to your liking.
5. You may now `cd` back into the originally created directory and execute
`whirl run` (or `whirl run distributor,hub` if you would like to run only a
select few of Whirl's sub-servers).
### Notes
Your configuration file can be found in `./whirl/`.
## Notes
systemd configuration may (?) come soon!
|