Update readme
This commit is contained in:
parent
2f4cd260fd
commit
a3d0c9bf31
17
README
17
README
|
@ -1,4 +1,4 @@
|
||||||
Web - A web client for Mastodon Network
|
Web - A web client for Mastodon Network[1]
|
||||||
|
|
||||||
Features:
|
Features:
|
||||||
|
|
||||||
|
@ -18,8 +18,8 @@ External dependencies:
|
||||||
|
|
||||||
Building and Installation:
|
Building and Installation:
|
||||||
|
|
||||||
Make sure you have GO installed. Other dependencies will be
|
Make sure you have GO installed. Other dependencies will be downloaded
|
||||||
downloaded automatically.
|
automatically.
|
||||||
|
|
||||||
Typing make will build the binary
|
Typing make will build the binary
|
||||||
$ make
|
$ make
|
||||||
|
@ -30,12 +30,14 @@ $ ed default.conf
|
||||||
Run the binary
|
Run the binary
|
||||||
$ ./web
|
$ ./web
|
||||||
|
|
||||||
You can also setup a reverse HTTP proxy serve the website over TLS connection.
|
You can now access the frontend at http://localhost:8080, which is the default
|
||||||
|
listen address. You can also setup a reverse HTTP proxy to serve the frontend over
|
||||||
|
TLS connection.
|
||||||
|
|
||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
|
|
||||||
You will need to clear the database if you change config values for client_name,
|
A database reset is required after changing the values of config options client_name,
|
||||||
client_scope or client_website.
|
client_scope or client_website.
|
||||||
|
|
||||||
|
|
||||||
|
@ -46,4 +48,7 @@ related and neighboring rights to this software to the public domain worldwide.
|
||||||
This software is distributed without any warranty.
|
This software is distributed without any warranty.
|
||||||
|
|
||||||
You should have received a copy of the CC0 Public Domain Dedication along with
|
You should have received a copy of the CC0 Public Domain Dedication along with
|
||||||
this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
|
this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.
|
||||||
|
|
||||||
|
|
||||||
|
[1] https://pleroma.social
|
||||||
|
|
Loading…
Reference in New Issue