Projects tigase _server server-core Issues #964
Update documentation of handling RepoItems configuration (#964)
wojciech.kapcia@tigase.net opened 6 years ago
  • create documentation explaining how to add/remove/update RepoItems (vhosts, external component) using both webui and xmpp
  • ~~adjust existing documents that explain to configure --external or particular VHost settings via configuration file with information that this should be done via xmpp/webUI and which options to set.~~
  • document in Admin Guide of 7.1.4 how to persist items in repository
  • ~~add information to documentation and to release notes that it's essential to first upgrade to 7.1.4 and then run Persist items (#8061) to force storing items to repository !~~ (this is not required in the end as during upgrade RepoItems will be correctly migrated via external file (etc/externalComponentItems)
Andrzej Wójcik (Tigase) commented 6 years ago

Please check if everything is there or if there is need to improve anything.

wojciech.kapcia@tigase.net commented 6 years ago
  • pictures seems to be missing (https://docs.tigase.org/tigase-server/snapshot/Administration_Guide/html/#tigaseExternalComponent pictures from Psi: "admin add user
  • "class is tigase.server.ext.ComponentProtocol which does not need to be specified." -> "class is tigase.server.ext.ComponentProtocol (class doesn't have to be specified when using default name)
  • "While this would load the component, there are no additional configurations provided to the component would be practically useless. " -> "While this would load the component, without any additional configurations provided, the component would be practically useless. "
  • "Connection type - accept to make component wait for connection or connect force component to connect to the server (`connect)" - misses formatting tick
  • "muc.devel.tigase.org:muc-pass:connect:5270:devel.tigase.org:accept" - shouldn't it be connect + connect (instead of connect + accept as per "connect - establish connection using XEP-0114: Jabber Component Protocol for connection to the server")?
    • given that we provide information about this method, we should also add information about it's path (and huge warning, that while this may work support for this method may be removed in the newer versions)
  • I think we should mention that if someone wants to configure external component without sharing database with main installation, it's necessary to explicitly add http component and explicitly configure it's class
  • # FINISHED # - to be removed
  • items configuration from config.tdsl from section Load Balancing External Component should be removed as it doesn't work (we should point to earlier section how to add/modify/remove entries)
wojciech.kapcia@tigase.net commented 6 years ago
  • Improve description of Protocol section:
    • divide them into two groups based on connection type (similar to previous documentation: protocol - if the connection type is 'connect' then the protorol is defined here - 'accept' for XEP-0114, 'client' for XEP-0225, possibly others in the future.
    • explain, that for it's optional for accept connection type (as per previous version: *It can be skipped for 'listen' connection types.)
Andrzej Wójcik (Tigase) commented 6 years ago

I've made requested changes, but to be honest it could be faster if you could make minor fixes on your own, ie. change wording.

issue 1 of 1
Type
New Feature
Priority
Normal
Assignee
RedmineID
7924
Version
tigase-server-8.0.0
Spent time
47h 30m
Issue Votes (0)
Watchers (0)
Reference
tigase/_server/server-core#964
Please wait...
Page is in error, reload to recover