Matrix/synapse
Matrix/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse synced 2024-07-08 16:24:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
synapse/docs/usage/administration
History
jejo86 2341032cf2
Document advising against publicly exposing the Admin API and provide a usage example (#13231) 
* Admin API request explanation improved

Pointed out, that the Admin API is not accessible by default from any remote computer, but only from the PC `matrix-synapse` is running on.
Added a full, working example, making sure to include the cURL flag `-X`, which needs to be prepended to `GET`, `POST`, `PUT` etc. and listing the full query string including protocol, IP address and port.

* Admin API request explanation improved

* Apply suggestions from code review

Update changelog. Reword prose.

Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
2022-07-13 19:33:33 +01:00
..
admin_api Document advising against publicly exposing the Admin API and provide a usage example (#13231) 2022-07-13 19:33:33 +01:00
monitoring Add documentation for phone home stats (#13086) 2022-06-30 22:12:28 +01:00
admin_faq.md Minor cleanup on recently ported doc pages (#11466) 2021-12-02 09:46:20 -08:00
database_maintenance_tools.md Minor cleanup on recently ported doc pages (#11466) 2021-12-02 09:46:20 -08:00
README.md Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 2021-06-03 17:20:40 +01:00
request_log.md Improve logging for cancelled requests (#12587) 2022-05-04 13:38:55 +01:00
state_groups.md Port wiki pages to documentation website (#11402) 2021-12-01 10:12:19 -08:00
understanding_synapse_through_grafana_graphs.md Minor cleanup on recently ported doc pages (#11466) 2021-12-02 09:46:20 -08:00
useful_sql_for_admins.md Update SQL statements in docs for Synapse Admins (#12536) 2022-05-09 14:43:02 -07:00

README.md

Administration

This section contains information on managing your Synapse homeserver. This includes:

  • Managing users, rooms and media via the Admin API.
  • Setting up metrics and monitoring to give you insight into your homeserver's health.
  • Configuring structured logging.