From 0bc74fa24da12e717c69c36508788a527d422070 Mon Sep 17 00:00:00 2001 From: Jan Kaluza Date: Tue, 9 Feb 2016 21:36:51 +0100 Subject: [PATCH] Describe Web Interface in docs --- _config.yml | 2 +- documentation/frontends/slack.md | 2 +- documentation/management/web_interface.md | 29 +++++++++++++++++++++++ 3 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 documentation/management/web_interface.md diff --git a/_config.yml b/_config.yml index 49fc148b..9187c4d2 100644 --- a/_config.yml +++ b/_config.yml @@ -3,7 +3,7 @@ #permalink: /:categories/:year/:month/:day/:title exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"] -highlighter: pygments +#highlighter: pygments # Themes are encouraged to use these universal variables # so be sure to set them if your theme uses them. diff --git a/documentation/frontends/slack.md b/documentation/frontends/slack.md index 62267eab..f68facb9 100644 --- a/documentation/frontends/slack.md +++ b/documentation/frontends/slack.md @@ -16,7 +16,7 @@ You have to choose this frontend in Spectrum 2 configuration file to use it: client_id=42132532467.11232153249 client_secret=cfdw9erw9ew0gew9gds0sa9wqd9f8d6a -To obtain the `client_id` and `client_secret` values, you have to create new Slack application on [Slack website](https://slack.com/apps/build). You also have to setup Spectrum 2 Web Interface to allow Slack users to register the transport and configure it. While creating new Slack application, you also have to setup the `Redirect URI`. Spectrum 2 Web Interface expects the `Redirect URI` to be configured as `http://domain.tld/oauth2`. You can choose whatever domain you are running at, but you have to preserve the `/oauth2` location. +To obtain the `client_id` and `client_secret` values, you have to create new Slack application on [Slack website](https://slack.com/apps/build). You also have to setup [Spectrum 2 Web Interface](../management/web_interface.html) to allow Slack users to register the transport and configure it. While creating new Slack application, you also have to setup the `Redirect URI`. Spectrum 2 Web Interface expects the `Redirect URI` to be configured as `http://domain.tld/oauth2`. You can choose whatever domain you are running at, but you have to preserve the `/oauth2` location. ## Usage diff --git a/documentation/management/web_interface.md b/documentation/management/web_interface.md new file mode 100644 index 00000000..66c1141b --- /dev/null +++ b/documentation/management/web_interface.md @@ -0,0 +1,29 @@ +--- +layout: page +title: Spectrum 2 +--- + +Web Interface allows admins to control Spectrum 2 instances and users to register the transports and for example manage rooms they are connected to. + +## Configuration + +The Web Interface is part of Spectrum 2 Manager tool, so it shares the same `/etc/spectrum2/spectrum_manager.cfg` configuration file. There are following configuration variables available: + +Section | Key | Type | Default | Description +----|------|---------|------------ +service | admin_username | string | | Admin username for the Web Interface. +service | admin_password | string | | Admin password for the Web Interface. +service | port | int | 8080 | Port on which the Web Interface will be accesible. +service | base_location | string | / | Base location (directory) on which the Web interface is served. It must ends up with slash character. If you for example set it to "/spectrum/", then the Web interface will be served on http://localhost:$port/spectrum/. +service | data_dir | string | /var/lib/spectrum2_manager/html | Path to the Web Interface static data. +service | cert | string | | Web interface certificate in PEM format when TLS should be used. Empty otherwise. +logging | config | string | /etc/spectrum2/manager_logging.cfg | Path to the logging configuration file in the same format as for the Spectrum 2. +database | ... | ... | ... | Database to store the Web Interface data. The variables are the same as in the [Spectrum 2 config files](http://spectrum.im/documentation/configuration/config_file.html#databasedatabase). + +## Starting the Web Interface + +For now the only way how to start Web Interface is running it on foreground using: + +`$ spectrum2_manager server` + +In the future, we plan to support Spectrum 2 Web Interface as standalone server.