817f818d66baa6a33df99144d213640bb78fb48b
[bloat] / README
1 Web - A web client for Mastodon Network
2
3 Features:
4
5 - Does not require JavaScript to display text, images, audio and videos.
6
7
8 Requirements:
9
10 - Go 1.11
11
12
13 External dependencies:
14
15 - Fork of go-masodon (https://github.com/mattn/go-mastodon)
16 - gorilla/mux (https://github.com/gorilla/mux)
17
18
19 Building and Installation:
20
21 Make sure you have GO installed. Other dependencies will be 
22 downloaded automatically.
23
24 Typing make will build the binary 
25 $ make
26
27 Edit the provided config file. See the default.conf file for more details.
28 $ ed default.conf
29
30 Run the binary
31 $ ./web
32
33 You can also setup a reverse HTTP proxy serve the website over TLS connection.
34
35
36 Notes:
37
38 You will need to clear the database if you change config values for client_name, 
39 client_scope or client_website.
40
41
42 License:
43
44 To the extent possible under law, the author have dedicated all copyright and
45 related and neighboring rights to this software to the public domain worldwide.
46 This software is distributed without any warranty.
47
48 You should have received a copy of the CC0 Public Domain Dedication along with
49 this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.