Merge pull request #65 from thelounge/v3-docs

Upgrade documentation for v3

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
 ## Release candidate (3.0.0-rc.5) (2018-11-21)
-- Bump [`thelounge`][1] to [`v3.0.0-rc.5`](https://github.com/thelounge/lounge/releases/tag/v3.0.0-rc.5).
+- Bump [`thelounge`][1] to [`v3.0.0-rc.5`](https://github.com/thelounge/thelounge/releases/tag/v3.0.0-rc.5).
 - Upgrade to `node v10`.
 
 #### Breaking Changes
@@ -13,60 +13,60 @@
 
 ## 2.7.1 (2018-02-19)
 
-- Bump [`thelounge`][1] to [`v2.7.1`](https://github.com/thelounge/lounge/releases/tag/v2.7.1).
+- Bump [`thelounge`][1] to [`v2.7.1`](https://github.com/thelounge/thelounge/releases/tag/v2.7.1).
 - Reorder Dockerfile directives to facilitate better docker build cache ([#44](https://github.com/thelounge/docker-lounge/pull/44) by [@mmlb](https://github.com/mmlb)).
 
 ## 2.7.0 (2018-01-29)
 
-- Bump [`thelounge`][1] to [`v2.7.0`](https://github.com/thelounge/lounge/releases/tag/v2.7.0).
+- Bump [`thelounge`][1] to [`v2.7.0`](https://github.com/thelounge/thelounge/releases/tag/v2.7.0).
 - Use `thelounge` executable instead of the deprecated `lounge` executable.
 - Use `THELOUNGE_HOME` environment variable instead of the deprecated `LOUNGE_HOME` environment variable.
     - This is an internal change and will not affect existing configurations.
 
 ## 2.6.0 (2017-11-19)
 
-- bump [`thelounge`][1] to [`v2.6.0`](https://github.com/thelounge/lounge/releases/tag/v2.6.0)
+- bump [`thelounge`][1] to [`v2.6.0`](https://github.com/thelounge/thelounge/releases/tag/v2.6.0)
 
 ## 2.5.0 (2017-10-17)
 
-- Bump [`thelounge`][1] to [`v2.5.0`](https://github.com/thelounge/lounge/releases/tag/v2.5.0).
+- Bump [`thelounge`][1] to [`v2.5.0`](https://github.com/thelounge/thelounge/releases/tag/v2.5.0).
 - Add a Makefile to help build images.
 - Discontinue the `LOUNGE_VERSION` environment variable in favor of the new `THELOUNGE_VERSION` build argument.
     - The `THELOUNGE_VERSION` build argument makes it possible to control which `thelounge` version to install via build arguments.
 
 ## 2.4.0 (2017-07-31)
 
-- Bump [`thelounge`][1] to [`v2.4.0`](https://github.com/thelounge/lounge/releases/tag/v2.4.0).
+- Bump [`thelounge`][1] to [`v2.4.0`](https://github.com/thelounge/thelounge/releases/tag/v2.4.0).
 
 ## 2.3.2 (2017-06-25)
 
-- Bump [`thelounge`][1] to [`v2.3.2`](https://github.com/thelounge/lounge/releases/tag/v2.3.2).
+- Bump [`thelounge`][1] to [`v2.3.2`](https://github.com/thelounge/thelounge/releases/tag/v2.3.2).
 
 ## 2.3.1 (2017-06-09)
 
-- Bump [`thelounge`][1] to [`v2.3.1`](https://github.com/thelounge/lounge/releases/tag/v2.3.1).
+- Bump [`thelounge`][1] to [`v2.3.1`](https://github.com/thelounge/thelounge/releases/tag/v2.3.1).
 
 ## 2.3.0 (2017-06-08)
 
-- Bump [`thelounge`][1] to [`v2.3.0`](https://github.com/thelounge/lounge/releases/tag/v2.3.0).
+- Bump [`thelounge`][1] to [`v2.3.0`](https://github.com/thelounge/thelounge/releases/tag/v2.3.0).
 - `vim(1)` and `nano(1)` are now installed in the base image `thelounge/lounge`. `alpine` and `slim` flavours are unaffected.
     - this allows editing configuration file from within the container via attaching to pseudo-TTYs.
 - `alpine` flavour is now based on the official alpine Node 6 LTS image.
 
 ## 2.2.2 (2017-03-13)
 
-- Bump [`thelounge`][1] to [`v2.2.2`](https://github.com/thelounge/lounge/releases/tag/v2.2.2).
+- Bump [`thelounge`][1] to [`v2.2.2`](https://github.com/thelounge/thelounge/releases/tag/v2.2.2).
 - Use `start` subcommand as default command ([#29](https://github.com/thelounge/docker-lounge/pull/29) by [@williamboman](https://github.com/williamboman)).
 
 ## 2.2.1 (2017-02-13)
 
-- Bump [`thelounge`][1] to [`v2.2.1`](https://github.com/thelounge/lounge/releases/tag/v2.2.1).
+- Bump [`thelounge`][1] to [`v2.2.1`](https://github.com/thelounge/thelounge/releases/tag/v2.2.1).
 - Use `CMD` directive in `Dockerfile` to facilitate user-defined commands ([#28](https://github.com/thelounge/docker-lounge/pull/28) by [@williamboman](https://github.com/williamboman)).
 
 
 ## 2.2.0 (2017-02-01)
 
-- Bump [`thelounge`][1] to [`v2.2.0`](https://github.com/thelounge/lounge/releases/tag/v2.2.0).
+- Bump [`thelounge`][1] to [`v2.2.0`](https://github.com/thelounge/thelounge/releases/tag/v2.2.0).
 - Add `alpine` and `slim` flavours of the official image ([#21](https://github.com/thelounge/docker-lounge/pull/21) by [@williamboman](https://github.com/williamboman)).
   - These flavours will henceforth be available via `-alpine` and `-slim`, e.g.;
     - `thelounge/lounge:2.2.0-alpine`
@@ -77,10 +77,10 @@
 
 ## 2.1.0 (2016-10-17)
 
-- Bump [`thelounge`][1] to [`v2.1.0`](https://github.com/thelounge/lounge/releases/tag/v2.1.0).
+- Bump [`thelounge`][1] to [`v2.1.0`](https://github.com/thelounge/thelounge/releases/tag/v2.1.0).
 - Image is now based on `node:6` ([#16](https://github.com/thelounge/docker-lounge/pull/16) by
   [@zkanda](https://github.com/zkanda)).
 - Now runs container as `root` user ([#17](https://github.com/thelounge/docker-lounge/pull/17) by
   [@zkanda](https://github.com/zkanda)).
 
-[1]: https://github.com/thelounge/lounge
+[1]: https://github.com/thelounge/thelounge

README.md

@@ -1,49 +1,27 @@
-<h1 align="center">
-	<img
-		width="300"
-		alt="The Lounge"
-		src="https://raw.githubusercontent.com/thelounge/thelounge/master/client/img/logo-vertical-transparent-bg.svg?sanitize=true">
-</h1>
-
-<h3 align="center">
-	Docker container for The Lounge, modern web IRC client designed for self-hosting
-</h3>
-
-<p align="center">
-	<strong>
-		<a href="https://thelounge.chat/">Website</a>
-		•
-		<a href="https://thelounge.chat/docs">Docs</a>
-		•
-		<a href="https://demo.thelounge.chat/">Demo</a>
-	</strong>
-</p>
-<p align="center">
-	<a href="https://demo.thelounge.chat/"><img
-		alt="#thelounge IRC channel on freenode"
-		src="https://img.shields.io/badge/freenode-%23thelounge-415364.svg?colorA=ff9e18&style=flat-square"></a>
-	<a href="https://hub.docker.com/r/thelounge/lounge/"><img
-		alt="Total pulls on Docker"
-		src="https://img.shields.io/docker/pulls/thelounge/lounge.svg?style=flat-square"></a>
-</p>
-
-## v3 pre-releases
-
-Documentation for v3 pre-releases can be found [here](https://github.com/thelounge/thelounge-docker/tree/v3-docs#readme). The documentation found on this page refers to the v2 branch. Don't forget to check the [CHANGELOG](CHANGELOG.md) if you're upgrading from v2!
-
-## Overview
-
-* **Modern features brought to IRC.** Push notifications, link previews, new message markers, and more bring IRC to the 21st century.
-* **Always connected.** Remains connected to IRC servers while you are offline.
-* **Cross platform.** It doesn't matter what OS you use, it just works wherever Node.js runs.
-* **Responsive interface.** The client works smoothly on every desktop, smartphone and tablet.
-* **Synchronized experience.** Always resume where you left off no matter what device.
+![The Lounge](https://raw.githubusercontent.com/thelounge/thelounge.github.io/master/assets/logos/logo/TL_Grey%26Yellow_Vertical_logotype_Transparent_Bg/TL_Grey%26Yellow_Vertical_logotype_Transparent_Bg.png)
+
+#### Docker container for The Lounge, modern web IRC client designed for self-hosting
+
+**[Website](https://thelounge.chat/) • [Docs](https://thelounge.chat/docs) • [Demo](https://demo.thelounge.chat/)**
+
+[![#thelounge IRC channel on freenode"](https://img.shields.io/badge/freenode-%23thelounge-415364.svg?colorA=ff9e18&style=flat-square)](https://demo.thelounge.chat/) [![Total pulls on Docker](https://img.shields.io/docker/pulls/thelounge/thelounge.svg?style=flat-square&maxAge=3600)](https://hub.docker.com/r/thelounge/thelounge/) [![Total stars on Docker](https://img.shields.io/docker/stars/thelounge/thelounge.svg?colorB=007dc7&style=flat-square&maxAge=3600)](https://hub.docker.com/r/thelounge/thelounge/)
+
+---
+
+### Overview
+
+-   **Modern features brought to IRC.** Push notifications, link previews, new message markers, and more bring IRC to the 21st century.
+-   **Always connected.** Remains connected to IRC servers while you are offline.
+-   **Cross platform.** It doesn't matter what OS you use, it just works wherever Node.js runs.
+-   **Responsive interface.** The client works smoothly on every desktop, smartphone and tablet.
+-   **Synchronized experience.** Always resume where you left off no matter what device.
 
 To learn more about configuration, usage and features of The Lounge, take a look at [the website](https://thelounge.chat).
 
-## Running a container
+### Running a container
 
 One can get started quickly by using the example [`docker-compose.yml`](https://github.com/thelounge/docker-lounge/blob/master/docker-compose.yml) file. [What is docker-compose?](https://docs.docker.com/compose/)
+
 ```sh
 $ docker-compose up --detach
 ```
@@ -52,45 +30,47 @@ or starting a container manually:
 
 ```
 $ docker run --detach \
-		--name thelounge \
-		--publish 9000:9000 \
-		--volume ~/.thelounge:/home/lounge/data \
-		--restart always \
-		thelounge/lounge:latest
+             --name thelounge \
+             --publish 9000:9000 \
+             --volume ~/.thelounge:/var/opt/thelounge \
+             --restart always \
+             thelounge/thelounge:latest
 ```
 
-## Data directory
+### Data directory
 
-The Lounge reads and stores all of its configuration, logs and other data at `/home/lounge/data`.
+The Lounge reads and stores all of its configuration, logs and other data at `/var/opt/thelounge`.
 
-*You will probably want to persist the data at this location by using [one of the means](https://docs.docker.com/storage/) to do so.*
+_You will probably want to persist the data at this location by using [one of the means](https://docs.docker.com/storage/) to do so._
 
-## Adding users
+### Adding users
 
 Users can be added as follows:
+
 ```sh
 $ docker exec -it <container_name> thelounge add <username>
 ```
 
-*Note: without [persisting data](#data-directory), added users will be lost when the container is removed.*
+_Note: without [persisting data](#data-directory), added users will be lost when the container is removed._
 
-## Changing the port that The Lounge will be available on
+### Changing the port that The Lounge will be available on
 
 To change the port which The Lounge will be available on, one will have to
 change the host port in the port mapping. To make The Lounge available on e.g. port 5000:
+
 ```sh
 $ docker run --detach \
-		--name thelounge \
-		--publish 5000:9000 \ # Change host port to listen on port 5000
-		--volume ~/.thelounge:/home/lounge/data \
-		--restart always \
-		thelounge/lounge:latest
+             --name thelounge \
+             --publish 5000:9000 \ # Change host port to listen on port 5000
+             --volume ~/.thelounge:/var/opt/thelounge \
+             --restart always \
+             thelounge/thelounge:3.0.0-pre.7
 ```
 
-## Environment variables (advanced usage)
+### Environment variables (advanced usage)
 
 You can control how The Lounge is started through the following environment variables;
 
-- `HOST` (equivalent to the `-H, --host` CLI option)
-- `PORT` (equivalent to the `-P, --port` CLI option)
-- `BIND` (equivalent to the `-B, --bind` CLI option)
+-   `HOST` (equivalent to the `-c host` CLI option)
+-   `PORT` (equivalent to the `-c port` CLI option)
+-   `BIND` (equivalent to the `-c bind` CLI option)

docker-compose.yml

@@ -1,10 +1,10 @@
 version: '2'
 services:
   thelounge:
-    image: thelounge/lounge:latest
+    image: thelounge/thelounge:latest
     container_name: thelounge
     ports:
       - "9000:9000"
     restart: always
     volumes:
-      - ~/.thelounge:/home/lounge/data # bind lounge config from the host's file system
+      - ~/.thelounge:/var/opt/thelounge # bind lounge config from the host's file system