synctl.ronn 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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 - we deliberately
  34. cache a lot of recent room data and metadata in RAM in order to speed up
  35. common requests. We'll improve this in the future, but for now the easiest
  36. way to either reduce the RAM usage (at the risk of slowing things down)
  37. is to set the almost-undocumented ``SYNAPSE_CACHE_FACTOR`` environment
  38. variable. The default is 0.5, which can be decreased to reduce RAM usage
  39. in memory constrained enviroments, or increased if performance starts to
  40. degrade.
  41. However, degraded performance due to a low cache factor, common on
  42. machines with slow disks, often leads to explosions in memory use due
  43. backlogged requests. In this case, reducing the cache factor will make
  44. things worse. Instead, try increasing it drastically. 2.0 is a good
  45. starting value.
  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)