diff --git a/README.md b/README.md index 032da5e..d9cbc18 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ Glowing Bear is a web frontend for the [WeeChat](https://weechat.org) IRC client ## Getting Started - Glowing Bear connects to the WeeChat instance you're already running (version 0.4.2 or later is required), and you need to be able to establish a connection to the WeeChat host from your device. It makes use of the relay plugin, and therefore you need to set up a relay. If you want to try this out with a local WeeChat instance, use these commands in WeeChat to create an **unencrypted relay** (see the note below): /relay add weechat 9001 @@ -40,7 +39,7 @@ Glowing Bear uses WeeChat directly as its backend through the relay plugin. This - *Can I use Glowing Bear to access a machine or port not exposed to the internet by passing the connection through my server?* No, that's not what Glowing Bear does. You can use a websocket proxy module for your webserver to forward `/weechat` to your WeeChat instance though. We've got instructions for setting this up [on our wiki](https://github.com/glowing-bear/glowing-bear/wiki/Proxying-WeeChat-relay-with-a-web-server). - *How does the encryption work?* TLS is used for securing the connection if you enable encryption. This is handled by your browser, and we have no influence on certificate handling, etc. You can find more detailed instructions on how to communicate securely in the "Getting Started" tab on the [landing page of our development version](https://latest.glowing-bear.org). -- *Can I make it so that there are no requests to third party servers at all?* Sure, you'll have to hide embeds by default (it's in the settings dialog), and download the JavaScript files for which we use a CDN by default. For the second step, you have two options: a) use the Electron app, or b) run `npm run make-local` to download the files and apply a patch to use them instead of the CDN. But remember to re-run this command whenever you update Glowing Bear! +- *Can I make it so that there are no requests to third party servers at all?* Sure, see #1186. More details to follow once it's merged ## Development @@ -49,6 +48,8 @@ Getting started with the development of Glowing Bear requires the installation o Now you can point your browser to [http://localhost:8000](http://localhost:8000)! +If you want to host Glowing Bear yourself, you should use a "proper" webserver like Caddy, nginx, or Apache. Run `npm run build` to bundle all the resources neded and then point your webserver to the `build/` folder. This is, in effect, the explicit way of doing what `npm start` does transparently in the background for development. + Remember that **you don't need to host Glowing Bear yourself to use it**, you can just use [our hosted version](https://www.glowing-bear.org) powered by GitHub pages, and we'll take care of updates for you. Your browser connects to WeeChat directly, so it does not matter where Glowing Bear is hosted. You can also use the latest and greatest development version of Glowing Bear at [https://latest.glowing-bear.org/](https://latest.glowing-bear.org/). For developers, branches of this repository are available at [https://pull.glowing-bear.org/**branchname**/](https://pull.glowing-bear.org/branchname/), and pull requests at [https://pull.glowing-bear.org/**123**/](https://pull.glowing-bear.org/123/)—note the trailing slashes. @@ -56,18 +57,7 @@ You can also use the latest and greatest development version of Glowing Bear at ### Running the tests Glowing Bear uses Karma and Jasmine to run its unit tests. To run the tests locally, you will first need to install `npm` on your machine. Check out the wonderful [nvm](https://github.com/creationix/nvm) if you don't know it already, it's highly recommended. -Once this is done, you will need to retrieve the necessary packages for testing Glowing-Bear (first, you might want to use `npm link` on any packages you have already installed globally): - -`$ npm install` - -Finally, you can run the unit tests: - -`$ npm test` - -Or the end to end tests: -`$ npm run protractor` - -**Note**: the end to end tests assume that a web server is hosting Glowing Bear on `localhost:8000` and that a WeeChat relay is configured on port 9001. +Once this is done, you will need to retrieve the necessary packages for testing Glowing-Bear (first, you might want to use `npm link` on any packages you have already installed globally) with `npm install`. Finally, you can run the unit tests with `npm test`, or the end to end tests with `npm run protractor` (note that the end to end tests assume that a web server is hosting Glowing Bear on `localhost:8000` and that a WeeChat relay is configured on port 9001.) ## Contributing