libtransport.git Changeset - 51695693ece7

Changeset - 51695693ece7

Parent rev.

Child rev.

[Not reviewed]

0 3 1

Jan Kaluza - 10 years ago 2016-02-20 21:58:10
jkaluza@redhat.com

Documentation: Document web_url and web_directory

4 files changed with 50 insertions and 0 deletions:

documentation/admin.md

documentation/backends/libpurple.md

documentation/configuration/config_file.md

documentation/configuration/web_storage.md

0 comments (0 inline, 0 general)

documentation/admin.md

➞

Show inline comments

 #### Configuration
 * [Configuration file description](configuration/config_file.html)
 * [MySQL Support](configuration/mysql.html)
 * [PostgreSQL Support](configuration/postgresql.html)
 * [Logging](configuration/logging.html)
 * [Web storage](configuration/web_storage.html);
 #### Management
 * [spectrum2_manager tool](management/spectrum2_manager.html)
 * [Web Interface](management/web_interface.html)
 * [Getting a backtrace](management/getting_backtrace.html)

documentation/backends/libpurple.md

➞

Show inline comments

@@ @@ -36,12 +36,16 @@ Protocol variable| website | Description @@
 prpl-facebook| [https://github.com/jgeboski/purple-facebook](website) | Facebook
 prpl-telegram| [https://github.com/majn/telegram-purple](website) | Telegram
 prpl-skypeweb| [https://github.com/EionRobb/skype4pidgin/tree/master/skypeweb](website) | Skype
 These plugins are included by default in our Docker image.
 ### Support for Facebook stickers
 Facebook stickers are supported using [Web Storage](../configuration/web_storage.html).
 ### Setting libpurple plugins configurations
 Some libpurple protocol plugins allow setting configuration variables. Spectrum 2 passes every variable set in `purple` section to libpurple library. If you need to set such options, you can do it for example like this in your configuration file:
 	[purple]
 	clientlogin=1

documentation/configuration/config_file.md

➞

Show inline comments

@@ @@ -36,16 +36,19 @@ title: Spectrum 2 @@
 > * [group](#servicegroup)
 > * [jid](#servicejid)
 > * [password](#servicepassword)
 > * [pidfile](#servicepidfile)
 > * [user](#serviceuser)
 > * [users_per_backend](#servicusersperbackend)
 > * [web_directory](#servicewebdirectory)
 > * [web_url](#serviceweburl)
 > * [working_dir](#serviceworkingdir)
 ### Types of configuration fields
 Following types are used:
 integer - Examples: key=0
@@ @@ -373,12 +376,41 @@ to have hundreds of backends). @@
 If you presume to have just few users on your personal server, it can be useful to configure `service.users_per_backend=1`. Ever user will
 get his own separated backend process.
 For bigger user-base, you have to increase the `service.users_per_backend` value, but there is no optimal value to be suggested yet.
 #### service.web_directory
 Key | val
 ----|----
 Description:|Full path to directory used to save files to which the links are sent to users.
 Context:|server-mode and gateway-mode
 Type:|string
 Default:|
 When Spectrum 2 has some image or file for the user and this option is set, the image or file is stored in this directory and
 and link based on `service.web_url` is sent to the user so he can download the file.
 You can read more about this configuration on [Web Storage page](web_storage.html).
 #### service.web_url
 Key | val
 ----|----
 Description:|URL on which files in `service.web_directory` are accessible.
 Context:|server-mode and gateway-mode
 Type:|string
 Default:|
 When Spectrum 2 has some image or file for the user and this option is set, the image or file is stored in the `service.web_directory` directory and
 and link based on `service.web_url` is sent to the user so he can download the file.
 You can read more about this configuration on [Web Storage page](web_storage.html).
 #### service.working_dir
 Key | val
 ----|----
 Description:|Configures path to directory when Spectrum 2 stores its data files.
 Context:|server-mode and gateway-mode

documentation/configuration/web_storage.md

➞

Show inline comments

@@ new file 100644 @@
 ---
 layout: page
 title: Spectrum 2
 ---
 ### Web Storage
 Web storage is used to send images and files received by Spectrum 2 to end user. When new image or file is downloaded from the 3rd-party network, it is stored into `service.web_directory` directory
 and the link to that file, based on `service.web_url`, is sent to the user.
 That means that you should configure the web-server on the machine where you run Spectrum 2 to serve `service.web_directory`.
 If you for example use httpd, you can configure `service.web_directory=/var/www/html/spectrum2`. In that case, the matching `service.web_url` value will be `service.web_url=http://domain.tld/spectrum2`.

0 comments (0 inline, 0 general)