synctl.ronn 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. synctl(1) -- Synapse server control interface
  2. =============================================
  3. ## SYNOPSIS
  4. Start, stop or restart synapse server.
  5. `synctl` {start|stop|restart} [configfile] [-w|--worker=<WORKERCONFIG>] [-a|--all-processes=<WORKERCONFIGDIR>]
  6. ## DESCRIPTION
  7. **synctl** can be used to start, stop or restart Synapse server. The
  8. control operation can be done on all processes or a single worker
  9. process.
  10. ## OPTIONS
  11. * `action`:
  12. The value of action should be one of `start`, `stop` or `restart`.
  13. * `configfile`:
  14. Optional path of the configuration file to use. Default value is
  15. `homeserver.yaml`. The configuration file must exist for the
  16. operation to succeed.
  17. * `-w`, `--worker`:
  18. Perform start, stop or restart operations on a single worker.
  19. Incompatible with `-a`|`--all-processes`. Value passed must be a
  20. valid worker's configuration file.
  21. * `-a`, `--all-processes`:
  22. Perform start, stop or restart operations on all the workers in
  23. the given directory and the main synapse process. Incompatible
  24. with `-w`|`--worker`. Value passed must be a directory containing
  25. valid work configuration files. All files ending with `.yaml`
  26. extension shall be considered as configuration files and all other
  27. files in the directory are ignored.
  28. ## CONFIGURATION FILE
  29. Configuration file may be generated as follows:
  30. $ python -B -m synapse.app.homeserver -c config.yaml --generate-config --server-name=<server name>
  31. ## ENVIRONMENT
  32. * `SYNAPSE_CACHE_FACTOR`:
  33. Synapse's architecture is quite RAM hungry currently - a lot of
  34. recent room data and metadata is deliberately cached in RAM in
  35. order to speed up common requests. This will be improved in
  36. future, but for now the easiest way to either reduce the RAM usage
  37. (at the risk of slowing things down) is to set the
  38. SYNAPSE_CACHE_FACTOR environment variable. Roughly speaking, a
  39. SYNAPSE_CACHE_FACTOR of 1.0 will max out at around 3-4GB of
  40. resident memory - this is what we currently run the matrix.org
  41. on. The default setting is currently 0.1, which is probably around
  42. a ~700MB footprint. You can dial it down further to 0.02 if
  43. desired, which targets roughly ~512MB. Conversely you can dial it
  44. up if you need performance for lots of users and have a box with a
  45. lot of RAM.
  46. ## COPYRIGHT
  47. This man page was written by Sunil Mohan Adapa <<sunil@medhas.org>> for
  48. Debian GNU/Linux distribution.
  49. ## SEE ALSO
  50. synapse_port_db(1), hash_password(1), register_new_matrix_user(1)