Show background images in profile headers.
[bloat] / INSTALL
1 Installation
2
3 1. Get the source
4 Get the source code by running
5 $ git clone https://git.freesoftwareextremist.com/bloat
6 You can also download the latest source tarball from the URL
7 "https://git.freesoftwareextremist.com/bloat/snapshot/bloat-master.tar.gz"
8
9 2. Build and install
10 Install GO from your system's package manager or from https://golang.org/dl.
11 Then run make to compile the source.
12 $ make
13 # make install
14 This will perform a system wide installation of bloat. By default, it will
15 install the binary in /usr/local/bin and data files in /usr/local/share/bloat.
16 You can change these paths by editing the Makefile.
17
18 3. Edit and copy the config file
19 Edit the generated config file to you liking and then copy it to the default
20 config location. Comments in the config file describe what each config value 
21 does. For most cases, you only need to change the value of "client_website".
22 $ $EDITOR bloat.def.conf
23 # cp bloat.def.conf /etc/bloat.conf
24
25 4. Create database directory
26 Create a directory to store session information. Optionally, create a user
27 to run bloat and change the ownership of the database directory accordingly.
28 # mkdir /var/bloat
29 # useradd _bloat
30 # chown -R _bloat:_bloat /var/bloat
31 Replace /var/bloat with the value you specified in the config file.
32
33 5. Run the binary
34 # su _bloat -c bloat
35 Now you should create an init script to automatically start bloat at system 
36 startup.
37
38
39 Update
40
41 Either run git pull to fetch the updated source or download the latest tarball
42 from the URL mentioned in the installation step. Then run make to install the
43 updated binary and data files
44 $ git pull
45 $ make 
46 # make install
47
48
49 Note: Commands starting with # are to be is to run as root.