diff options
author | Felix Ableitner <me@nutomic.com> | 2020-06-09 14:01:26 +0200 |
---|---|---|
committer | Felix Ableitner <me@nutomic.com> | 2020-06-09 14:01:26 +0200 |
commit | 0f1a8ec928a36d73490a41a778244578f39dd626 (patch) | |
tree | e55ec80acbb258197ce899cefe6e1b24e09ad2fb /docs | |
parent | 5c6601cb2a819d20b0f0d17f3575aff006a47fd2 (diff) | |
parent | a13e9fe3959e07f901ba0647dfd7f749865a900d (diff) |
Merge branch 'master' into federation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/img/chat_screen.png | bin | 0 -> 79469 bytes | |||
-rw-r--r-- | docs/img/main_screen.png | bin | 0 -> 94316 bytes | |||
-rw-r--r-- | docs/img/rank_algorithm.png | bin | 0 -> 55191 bytes | |||
-rw-r--r-- | docs/src/about.md | 2 | ||||
-rw-r--r-- | docs/src/about_ranking.md | 2 | ||||
-rw-r--r-- | docs/src/administration_install_docker.md | 7 | ||||
-rw-r--r-- | docs/src/contributing_federation_development.md | 4 | ||||
-rw-r--r-- | docs/src/contributing_websocket_http_api.md | 2 |
8 files changed, 9 insertions, 8 deletions
diff --git a/docs/img/chat_screen.png b/docs/img/chat_screen.png Binary files differnew file mode 100644 index 00000000..21a452dc --- /dev/null +++ b/docs/img/chat_screen.png diff --git a/docs/img/main_screen.png b/docs/img/main_screen.png Binary files differnew file mode 100644 index 00000000..5d1f0c32 --- /dev/null +++ b/docs/img/main_screen.png diff --git a/docs/img/rank_algorithm.png b/docs/img/rank_algorithm.png Binary files differnew file mode 100644 index 00000000..c8200f91 --- /dev/null +++ b/docs/img/rank_algorithm.png diff --git a/docs/src/about.md b/docs/src/about.md index 31081f48..2c0e418b 100644 --- a/docs/src/about.md +++ b/docs/src/about.md @@ -2,7 +2,7 @@ Front Page|Post ---|--- -![main screen](https://i.imgur.com/kZSRcRu.png)|![chat screen](https://i.imgur.com/4XghNh6.png) +![main screen](https://raw.githubusercontent.com/LemmyNet/lemmy/master/docs/img/main_screen.png)|![chat screen](https://raw.githubusercontent.com/LemmyNet/lemmy/master/docs/img/chat_screen.png) [Lemmy](https://github.com/LemmyNet/lemmy) is similar to sites like [Reddit](https://reddit.com), [Lobste.rs](https://lobste.rs), [Raddle](https://raddle.me), or [Hacker News](https://news.ycombinator.com/): you subscribe to forums you're interested in, post links and discussions, then vote, and comment on them. Behind the scenes, it is very different; anyone can easily run a server, and all these servers are federated (think email), and connected to the same universe, called the [Fediverse](https://en.wikipedia.org/wiki/Fediverse). diff --git a/docs/src/about_ranking.md b/docs/src/about_ranking.md index d318ae82..fe9e82bb 100644 --- a/docs/src/about_ranking.md +++ b/docs/src/about_ranking.md @@ -26,4 +26,4 @@ Gravity = Decay gravity, 1.8 is default A plot of rank over 24 hours, of scores of 1, 5, 10, 100, 1000, with a scale factor of 10k. -![](https://i.imgur.com/w8oBLlL.png) +![](https://raw.githubusercontent.com/LemmyNet/lemmy/master/docs/img/rank_algorithm.png) diff --git a/docs/src/administration_install_docker.md b/docs/src/administration_install_docker.md index 391299b3..236faa6b 100644 --- a/docs/src/administration_install_docker.md +++ b/docs/src/administration_install_docker.md @@ -10,12 +10,13 @@ cd /lemmy wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/lemmy.hjson wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/iframely.config.local.js -docker-compose up -d ``` -After this, have a look at the [config file](administration_configuration.md) named `lemmy.hjson`, and adjust it, in particular the hostname. +After this, have a look at the [config file](administration_configuration.md) named `lemmy.hjson`, and adjust it, in particular the hostname, and possibly the db password. Then run: + +`docker-compose up -d` -To make Lemmy available outside the server, you need to setup a reverse proxy, like Nginx. [A sample nginx config](/ansible/templates/nginx.conf), could be setup with: +To make Lemmy available outside the server, you need to setup a reverse proxy, like Nginx. [A sample nginx config](https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf), could be setup with: ```bash wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf diff --git a/docs/src/contributing_federation_development.md b/docs/src/contributing_federation_development.md index bcac4caa..80567e60 100644 --- a/docs/src/contributing_federation_development.md +++ b/docs/src/contributing_federation_development.md @@ -5,12 +5,12 @@ If you don't have a local clone of the Lemmy repo yet, just run the following command: ```bash -git clone https://yerbamate.dev/LemmyNet/lemmy.git -b federation +git clone https://github.com/LemmyNet/lemmy -b federation ``` If you already have the Lemmy repo cloned, you need to add a new remote: ```bash -git remote add federation https://yerbamate.dev/LemmyNet/lemmy.git +git remote add federation https://github.com/LemmyNet/lemmy git checkout federation git pull federation federation ``` diff --git a/docs/src/contributing_websocket_http_api.md b/docs/src/contributing_websocket_http_api.md index f228f94e..567f674c 100644 --- a/docs/src/contributing_websocket_http_api.md +++ b/docs/src/contributing_websocket_http_api.md @@ -1,6 +1,6 @@ # Lemmy API -*Note: this may lag behind the actual API endpoints [here](../server/src/api).* +*Note: this may lag behind the actual API endpoints [here](../server/src/api). The API should be considered unstable and may change any time.* <!-- toc --> |