summarylogtreecommitdiffstats
path: root/README.md
blob: dd56bbaf8802097d775a086ed3865e921be8a703 (plain)
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
# Arch Linux package for The Lounge

This is a clone of the repository [already available](https://aur.archlinux.org/packages/thelounge/) on the [AUR](https://wiki.archlinux.org/index.php/Arch_User_Repository).

This repository is to be used to track Arch Linux's specific issues with this package and allow users to contribute to it.

## Installation

Please follow the usual Arch Linux documentation to install this package from the AUR either manually or using your favorite AUR helper. These instructions are only provided as a quick example, but as typical with Arch Linux you are strongly encouraged to read the approprite documentation.

### Manually
```
$ git clone https://github.com/thelounge/thelounge-archlinux.git
$ cd arch-lounge
$ # optional: select your release (experimental, master, stable)
$ git checkout stable
$ makepkg
# pacman -U thelounge-*.pkg.*
```

### With an AUR helper
with pacaur:
```
$ pacaur -aS thelounge
```

or with yaourt:
```
$ yaourt -aS thelounge
```

### Configuration
The default system-wide documentation file is located at `/etc/thelounge/config.js`. Please note that user profiles and their IRC passwords are also stored there (moving to `/var/lib/thelounge` is planned but not yet done), so the directory is only readable by the `thelounge` user.

### Running
The Lounge provides both a system-wide and per-user systemd unit.

#### System
Simply enable the `thelounge.service` unit, and your server should be up and running:

```
# systemctl enable --now thelounge.service
```

#### User
If you do not want to run the software system-wide, or host multiple users that wish to host their own instance of The Lounge, it can also be launched per user:

```
$ systemctl --user enable --now thelounge.service
```

Please note that for The Lounge to start on boot in this scenario, you will also require to have [lingering](https://wiki.archlinux.org/index.php/Systemd/User#Automatic_start-up_of_systemd_user_instances) enabled for this user:

```
# loginctl enable-linger $username
```