diff options
Diffstat (limited to 'develop/index.html')
-rw-r--r-- | develop/index.html | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/develop/index.html b/develop/index.html index be8e465006..ae12c61fee 100644 --- a/develop/index.html +++ b/develop/index.html @@ -186,6 +186,87 @@ <p>Welcome to the documentation repository for Synapse, a <a href="https://matrix.org">Matrix</a> homeserver implementation developed by the matrix.org core team.</p> +<h2 id="installing-and-using-synapse"><a class="header" href="#installing-and-using-synapse">Installing and using Synapse</a></h2> +<p>This documentation covers topics for <strong>installation</strong>, <strong>configuration</strong> and +<strong>maintainence</strong> of your Synapse process:</p> +<ul> +<li> +<p>Learn how to <a href="setup/installation.html">install</a> and +<a href="usage/configuration/index.html">configure</a> your own instance, perhaps with <a href="usage/configuration/user_authentication/index.html">Single +Sign-On</a>.</p> +</li> +<li> +<p>See how to <a href="upgrade.html">upgrade</a> between Synapse versions.</p> +</li> +<li> +<p>Administer your instance using the <a href="usage/administration/admin_api/index.html">Admin +API</a>, installing <a href="modules/index.html">pluggable +modules</a>, or by accessing the <a href="manhole.html">manhole</a>.</p> +</li> +<li> +<p>Learn how to <a href="usage/administration/request_log.html">read log lines</a>, configure +<a href="usage/configuration/logging_sample_config.html">logging</a> or set up <a href="structured_logging.html">structured +logging</a>.</p> +</li> +<li> +<p>Scale Synapse through additional <a href="workers.html">worker processes</a>.</p> +</li> +<li> +<p>Set up <a href="metrics-howto.html">monitoring and metrics</a> to keep an eye on your +Synapse instance's performance.</p> +</li> +</ul> +<h2 id="developing-on-synapse"><a class="header" href="#developing-on-synapse">Developing on Synapse</a></h2> +<p>Contributions are welcome! Synapse is primarily written in +<a href="https://python.org">Python</a>. As a developer, you may be interested in the +following documentation:</p> +<ul> +<li> +<p>Read the <a href="development/contributing_guide.html">Contributing Guide</a>. It is meant +to walk new contributors through the process of developing and submitting a +change to the Synapse codebase (which is <a href="https://github.com/matrix-org/synapse">hosted on +GitHub</a>).</p> +</li> +<li> +<p>Set up your <a href="development/contributing_guide.html#2-what-do-i-need">development +environment</a>, then learn +how to <a href="development/contributing_guide.html#run-the-linters">lint</a> and +<a href="development/contributing_guide.html#8-test-test-test">test</a> your code.</p> +</li> +<li> +<p>Look at <a href="https://github.com/matrix-org/synapse/issues">the issue tracker</a> for +bugs to fix or features to add. If you're new, it may be best to start with +those labeled <a href="https://github.com/matrix-org/synapse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">good first +issue</a>.</p> +</li> +<li> +<p>Understand <a href="development/internal_documentation/index.html">how Synapse is +built</a>, how to <a href="development/database_schema.html">migrate +database schemas</a>, learn about +<a href="federate.html">federation</a> and how to <a href="federate.html#running-a-demo-federation-of-synapses">set up a local +federation</a> for development.</p> +</li> +<li> +<p>We like to keep our <code>git</code> history clean. <a href="development/git.html">Learn</a> how to +do so!</p> +</li> +<li> +<p>And finally, contribute to this documentation! The source for which is +<a href="https://github.com/matrix-org/synapse/tree/develop/docs">located here</a>.</p> +</li> +</ul> +<h2 id="donating-to-synapse-development"><a class="header" href="#donating-to-synapse-development">Donating to Synapse development</a></h2> +<p>Want to help keep Synapse going but don't know how to code? Synapse is a +<a href="https://matrix.org">Matrix.org Foundation</a> project. Consider becoming a +supportor on <a href="https://liberapay.com/matrixdotorg">Liberapay</a>, +<a href="https://patreon.com/matrixdotorg">Patreon</a> or through +<a href="https://paypal.me/matrixdotorg">PayPal</a> via a one-time donation.</p> +<p>If you are an organisation or enterprise and would like to sponsor development, +reach out to us over email at: support (at) matrix.org</p> +<h2 id="reporting-a-security-vulnerability"><a class="header" href="#reporting-a-security-vulnerability">Reporting a security vulnerability</a></h2> +<p>If you've found a security issue in Synapse or any other Matrix.org Foundation +project, please report it to us in accordance with our <a href="https://www.matrix.org/security-disclosure-policy/">Security Disclosure +Policy</a>. Thank you!</p> </main> |