A web based synapse config generator
  • JavaScript 75.9%
  • Python 20.1%
  • SCSS 3.8%
  • HTML 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Neil Johnson d64c03a014
typo
2019-10-02 15:39:26 +01:00
synapseconfiggenerator typo 2019-10-01 14:05:06 +01:00
tests Tests 2019-09-12 15:26:24 +01:00
webui Add option to write out config without starting synapse. 2019-09-13 16:19:43 +01:00
.babelrc Move yarn install to top level. 2019-09-11 18:55:42 +01:00
.eslintrc.js Move yarn install to top level. 2019-09-11 18:55:42 +01:00
.gitignore ignore build data 2019-09-12 12:19:03 +01:00
.stylelintrc.js Move yarn install to top level. 2019-09-11 18:55:42 +01:00
CONTRIBUTING.rst Update docs to reflect new install instructions 2019-09-12 15:49:10 +01:00
LICENSE License info 2019-09-06 15:59:23 +01:00
package.json Move yarn install to top level. 2019-09-11 18:55:42 +01:00
README.rst typo 2019-10-02 15:39:26 +01:00
setup.py Package data works! 2019-09-12 12:18:55 +01:00
webpack.config.babel.js Don't watch when running build 2019-10-01 13:31:39 +01:00
yarn.lock Move yarn install to top level. 2019-09-11 18:55:42 +01:00

synapse-config-generator (SCG)
==============================

synapse-config-generator is a config generator for synapse. It gathers together
the critical decision points of a first time synapse install and provides a
pretty ui to walk new users through them. The result of using
SCG is a yaml file akin to the sample config found in
`synapse's docs <https://github.com/matrix-org/synapse/tree/develop/docs>`_.
Through using SCG the user also gains a knowledge of the environment in
which synapse will be running.

Getting started
===============

.. code::

  pip install .
  synapse-config-generator --configdir config_dir