diff --git a/LICENSE b/LICENSE index 6f9d3213..ef1b2821 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,6 @@ The MIT License (MIT) +Copyright (c) 2023 SuperNETs Copyright (c) 2016 All contributors to The Lounge Copyright (c) 2014 Mattias Erming and contributors, as part of Shout. diff --git a/README.md b/README.md index 31665ab7..1d8985d0 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,15 @@ -
- - Website - • - Docs - • - Demo - • - Docker - -
- +# Deployment -- -
+1. Create a `docker-compose.yml` file in the directory you wish The Lounge to be in, use the one in this repo as an example. +2. Create the `config/` folder in the same directory. +3. Run `docker compose up` to bring up the container and generate required files, you may Ctrl+C it after that. +4. Edit the config file located at `config/config.js`, it is well documented and has not been changed so the original The Lounge documentation applies here. +5. Bring up the container for good using `docker compose up -d`. -## Overview +# Support -- **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). - -The Lounge is the official and community-managed fork of [Shout](https://github.com/erming/shout), by [Mattias Erming](https://github.com/erming). - -## Installation and usage - -The Lounge requires latest [Node.js](https://nodejs.org/) LTS version or more recent. -The [Yarn package manager](https://yarnpkg.com/) is also recommended. -If you want to install with npm, `--unsafe-perm` is required for a correct install. - -### Running stable releases - -Please refer to the [install and upgrade documentation on our website](https://thelounge.chat/docs/install-and-upgrade) for all available installation methods. - -### Running from source - -The following commands install and run the development version of The Lounge: - -```sh -git clone https://github.com/thelounge/thelounge.git -cd thelounge -yarn install -NODE_ENV=production yarn build -yarn start -``` - -When installed like this, `thelounge` executable is not created. Use `node index+ + Website + • + Docs + • + Demo + • + Docker + +
+ + ++ +
+ +## 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). + +The Lounge is the official and community-managed fork of [Shout](https://github.com/erming/shout), by [Mattias Erming](https://github.com/erming). + +## Installation and usage + +The Lounge requires latest [Node.js](https://nodejs.org/) LTS version or more recent. +The [Yarn package manager](https://yarnpkg.com/) is also recommended. +If you want to install with npm, `--unsafe-perm` is required for a correct install. + +### Running stable releases + +Please refer to the [install and upgrade documentation on our website](https://thelounge.chat/docs/install-and-upgrade) for all available installation methods. + +### Running from source + +The following commands install and run the development version of The Lounge: + +```sh +git clone https://github.com/thelounge/thelounge.git +cd thelounge +yarn install +NODE_ENV=production yarn build +yarn start +``` + +When installed like this, `thelounge` executable is not created. Use `node index