Repository: etkecc/synapse-admin Branch: main Commit: cf66c8e3a49e Files: 345 Total size: 1.9 MB Directory structure: gitextract_pt5yit7t/ ├── .dockerignore ├── .editorconfig ├── .gitattributes ├── .github/ │ ├── CONTRIBUTING.md │ ├── ISSUE_TEMPLATE/ │ │ ├── bug_report.md │ │ └── feature_request.md │ ├── SECURITY.md │ ├── dependabot.yml │ └── workflows/ │ ├── reuse.yml │ └── workflow.yml ├── .gitignore ├── .prettierignore ├── .watchmanconfig ├── LICENSE ├── LICENSES/ │ ├── Apache-2.0.txt │ ├── BSD-2-Clause.txt │ ├── CC0-1.0.txt │ ├── MIT.txt │ └── OFL-1.1.txt ├── README.md ├── REUSE.toml ├── docker/ │ ├── Dockerfile │ ├── Dockerfile.build │ ├── Dockerfile.subpath-admin │ ├── docker-compose-dev.yml │ └── docker-compose.yml ├── docs/ │ ├── README.md │ ├── apis.md │ ├── availability.md │ ├── components.md │ ├── config.md │ ├── configurable-columns.md │ ├── cors-credentials.md │ ├── csv-import.md │ ├── custom-menu.md │ ├── event-reports.md │ ├── external-auth-provider.md │ ├── federation.md │ ├── media.md │ ├── prefill-login-form.md │ ├── registration-tokens.md │ ├── restrict-hs.md │ ├── reverse-proxy.md │ ├── room-management.md │ ├── screenshots/ │ │ ├── README.md │ │ └── prepare.js │ ├── server-statistics.md │ ├── system-users.md │ ├── testdata/ │ │ ├── element/ │ │ │ ├── config.json │ │ │ └── nginx.conf │ │ ├── mas/ │ │ │ └── config.yaml │ │ ├── nginx/ │ │ │ └── nginx.conf │ │ ├── postgres.initdb/ │ │ │ └── mas.sql │ │ └── synapse/ │ │ ├── homeserver.yaml │ │ ├── synapse.log.config │ │ └── synapse.signing.key │ ├── update-api-docs.ts │ ├── user-badges.md │ ├── user-management.md │ ├── user-search.md │ └── well-known-discovery.md ├── eslint.config.js ├── justfile ├── package.json ├── public/ │ ├── config.json │ ├── data/ │ │ └── example.csv │ └── robots.txt ├── src/ │ ├── App.test.tsx │ ├── App.tsx │ ├── Context.tsx │ ├── TEST_COVERAGE_TODO.md │ ├── assets/ │ │ ├── fonts.css │ │ └── theme.ts │ ├── components/ │ │ ├── MatrixWordmark.tsx │ │ ├── README.md │ │ ├── etke.cc/ │ │ │ ├── BillingPage.tsx │ │ │ ├── BillingStatusBadge.tsx │ │ │ ├── ComponentsPage.tsx │ │ │ ├── CurrentlyRunningCommand.tsx │ │ │ ├── EtkeAttribution.test.tsx │ │ │ ├── EtkeAttribution.tsx │ │ │ ├── InstanceConfig.tsx │ │ │ ├── README.md │ │ │ ├── RichTextEditor.tsx │ │ │ ├── ServerActionsPage.tsx │ │ │ ├── ServerCommandsPanel.tsx │ │ │ ├── ServerNotificationsBadge.test.tsx │ │ │ ├── ServerNotificationsBadge.tsx │ │ │ ├── ServerNotificationsPage.tsx │ │ │ ├── ServerNotificationsUnavailable.test.tsx │ │ │ ├── ServerNotificationsUnavailable.tsx │ │ │ ├── ServerStatusBadge.test.tsx │ │ │ ├── ServerStatusBadge.tsx │ │ │ ├── ServerStatusPage.test.tsx │ │ │ ├── ServerStatusPage.tsx │ │ │ ├── SupportAttachments.tsx │ │ │ ├── SupportPage.tsx │ │ │ ├── SupportRequestPage.tsx │ │ │ ├── hooks/ │ │ │ │ ├── useServerCommands.ts │ │ │ │ └── useUnits.ts │ │ │ └── schedules/ │ │ │ ├── components/ │ │ │ │ ├── recurring/ │ │ │ │ │ ├── RecurringCommandEdit.tsx │ │ │ │ │ ├── RecurringCommandsList.tsx │ │ │ │ │ └── RecurringDeleteButton.tsx │ │ │ │ └── scheduled/ │ │ │ │ ├── ScheduledCommandEdit.tsx │ │ │ │ ├── ScheduledCommandShow.tsx │ │ │ │ ├── ScheduledCommandsList.tsx │ │ │ │ └── ScheduledDeleteButton.tsx │ │ │ └── hooks/ │ │ │ ├── useRecurringCommands.tsx │ │ │ └── useScheduledCommands.tsx │ │ ├── hooks/ │ │ │ ├── useDocTitle.test.tsx │ │ │ └── useDocTitle.tsx │ │ ├── layout/ │ │ │ ├── AdminLayout.test.tsx │ │ │ ├── AdminLayout.tsx │ │ │ ├── Datagrid.test.tsx │ │ │ ├── Datagrid.tsx │ │ │ ├── EmptyState.test.tsx │ │ │ ├── EmptyState.tsx │ │ │ ├── Footer.test.tsx │ │ │ ├── Footer.tsx │ │ │ ├── List.tsx │ │ │ ├── LoginFormBox.tsx │ │ │ └── index.ts │ │ ├── media/ │ │ │ ├── DeleteMediaButton.tsx │ │ │ ├── ProtectMediaButton.tsx │ │ │ ├── PurgeRemoteMediaButton.tsx │ │ │ ├── QuarantineMediaButton.tsx │ │ │ ├── ViewMedia.tsx │ │ │ └── index.ts │ │ ├── rooms/ │ │ │ ├── EventLookupDialog.tsx │ │ │ ├── RoomHierarchy.test.ts │ │ │ ├── RoomHierarchy.tsx │ │ │ └── RoomMessages.tsx │ │ ├── user-import/ │ │ │ ├── ConflictModeCard.tsx │ │ │ ├── ErrorsCard.tsx │ │ │ ├── ResultsCard.tsx │ │ │ ├── StartImportCard.tsx │ │ │ ├── StatsCard.tsx │ │ │ ├── UploadCard.tsx │ │ │ ├── UserImport.tsx │ │ │ ├── types.ts │ │ │ ├── useImportFile.test.ts │ │ │ └── useImportFile.tsx │ │ └── users/ │ │ ├── AdminClientConfigItems.tsx │ │ ├── DeviceDisplayNameInput.tsx │ │ ├── ExperimentalFeatures.tsx │ │ ├── ServerNotices.tsx │ │ ├── UserAccountData.tsx │ │ ├── UserCounts.tsx │ │ ├── UserRateLimits.tsx │ │ ├── buttons/ │ │ │ ├── AllowCrossSigningButton.tsx │ │ │ ├── BlockRoomButton.tsx │ │ │ ├── DeleteAllMediaButton.tsx │ │ │ ├── DeleteRoomButton.tsx │ │ │ ├── DeleteUserButton.tsx │ │ │ ├── DeviceCreateButton.tsx │ │ │ ├── DeviceRemoveButton.tsx │ │ │ ├── FindUserButton.tsx │ │ │ ├── LoginAsUserButton.tsx │ │ │ ├── PurgeHistoryButton.tsx │ │ │ ├── QuarantineAllMediaButton.tsx │ │ │ ├── RenewAccountValidityButton.tsx │ │ │ └── ResetPasswordButton.tsx │ │ └── fields/ │ │ ├── AvatarField.test.tsx │ │ ├── AvatarField.tsx │ │ └── EditableAvatarField.tsx │ ├── entrypoints/ │ │ ├── auth-callback.html │ │ └── index.html │ ├── i18n/ │ │ ├── README.md │ │ ├── de/ │ │ │ ├── base.ts │ │ │ ├── common.ts │ │ │ ├── index.ts │ │ │ ├── mas.ts │ │ │ ├── misc_resources.ts │ │ │ ├── reports.ts │ │ │ ├── rooms.ts │ │ │ └── users.ts │ │ ├── en/ │ │ │ ├── common.ts │ │ │ ├── index.ts │ │ │ ├── mas.ts │ │ │ ├── misc_resources.ts │ │ │ ├── reports.ts │ │ │ ├── rooms.ts │ │ │ └── users.ts │ │ ├── fa/ │ │ │ ├── base.ts │ │ │ ├── common.ts │ │ │ ├── index.ts │ │ │ ├── mas.ts │ │ │ ├── misc_resources.ts │ │ │ ├── reports.ts │ │ │ ├── rooms.ts │ │ │ └── users.ts │ │ ├── fr/ │ │ │ ├── common.ts │ │ │ ├── index.ts │ │ │ ├── mas.ts │ │ │ ├── misc_resources.ts │ │ │ ├── reports.ts │ │ │ ├── rooms.ts │ │ │ └── users.ts │ │ ├── i18n-keys.test.ts │ │ ├── index.test.ts │ │ ├── index.ts │ │ ├── it/ │ │ │ ├── base.ts │ │ │ ├── common.ts │ │ │ ├── index.ts │ │ │ ├── mas.ts │ │ │ ├── misc_resources.ts │ │ │ ├── reports.ts │ │ │ ├── rooms.ts │ │ │ └── users.ts │ │ ├── ja/ │ │ │ ├── base.ts │ │ │ ├── common.ts │ │ │ ├── index.ts │ │ │ ├── mas.ts │ │ │ ├── misc_resources.ts │ │ │ ├── reports.ts │ │ │ ├── rooms.ts │ │ │ └── users.ts │ │ ├── pt/ │ │ │ ├── base.ts │ │ │ ├── common.ts │ │ │ ├── index.ts │ │ │ ├── mas.ts │ │ │ ├── misc_resources.ts │ │ │ ├── reports.ts │ │ │ ├── rooms.ts │ │ │ └── users.ts │ │ ├── ru/ │ │ │ ├── base.ts │ │ │ ├── common.ts │ │ │ ├── index.ts │ │ │ ├── mas.ts │ │ │ ├── misc_resources.ts │ │ │ ├── reports.ts │ │ │ ├── rooms.ts │ │ │ └── users.ts │ │ ├── types.d.ts │ │ ├── uk/ │ │ │ ├── base.ts │ │ │ ├── common.ts │ │ │ ├── index.ts │ │ │ ├── mas.ts │ │ │ ├── misc_resources.ts │ │ │ ├── reports.ts │ │ │ ├── rooms.ts │ │ │ └── users.ts │ │ └── zh/ │ │ ├── base.ts │ │ ├── common.ts │ │ ├── index.ts │ │ ├── mas.ts │ │ ├── misc_resources.ts │ │ ├── reports.ts │ │ ├── rooms.ts │ │ └── users.ts │ ├── index.tsx │ ├── pages/ │ │ ├── DonatePage.test.tsx │ │ ├── DonatePage.tsx │ │ ├── LoginPage.test.tsx │ │ ├── LoginPage.tsx │ │ ├── MASPolicyDataPage.test.tsx │ │ ├── MASPolicyDataPage.tsx │ │ ├── auth-callback-error.test.tsx │ │ ├── auth-callback-error.tsx │ │ ├── auth-callback.test.tsx │ │ └── auth-callback.tsx │ ├── providers/ │ │ ├── README.md │ │ ├── auth/ │ │ │ ├── index.test.ts │ │ │ └── index.ts │ │ ├── data/ │ │ │ ├── etke.test.ts │ │ │ ├── etke.ts │ │ │ ├── index.test.ts │ │ │ ├── index.ts │ │ │ ├── lifecycle.ts │ │ │ ├── mas-actions.ts │ │ │ ├── mas-utils.test.ts │ │ │ ├── mas-utils.ts │ │ │ ├── mas.ts │ │ │ ├── scan.ts │ │ │ ├── synapse-actions.ts │ │ │ └── synapse.ts │ │ ├── http.ts │ │ ├── matrix.test.ts │ │ ├── matrix.ts │ │ ├── serverVersion.ts │ │ └── types/ │ │ ├── common.ts │ │ ├── destinations.ts │ │ ├── etke.ts │ │ ├── index.ts │ │ ├── mas.ts │ │ ├── reports.ts │ │ ├── rooms.ts │ │ └── users.ts │ ├── resourceMap.ts │ ├── resources/ │ │ ├── README.md │ │ ├── destinations/ │ │ │ ├── List.tsx │ │ │ └── index.ts │ │ ├── mas/ │ │ │ ├── CompatSessions.tsx │ │ │ ├── OAuth2Sessions.tsx │ │ │ ├── PersonalSessions.tsx │ │ │ ├── UpstreamOAuthLinks.tsx │ │ │ ├── UpstreamOAuthProviders.tsx │ │ │ ├── UserEmails.tsx │ │ │ ├── UserSessions.tsx │ │ │ ├── index.ts │ │ │ └── shared.tsx │ │ ├── registration-tokens/ │ │ │ ├── Create.tsx │ │ │ ├── Edit.tsx │ │ │ ├── List.tsx │ │ │ └── index.ts │ │ ├── reports/ │ │ │ ├── List.tsx │ │ │ ├── Show.tsx │ │ │ └── index.ts │ │ ├── room-directory/ │ │ │ └── index.tsx │ │ ├── rooms/ │ │ │ ├── List.tsx │ │ │ ├── Show.tsx │ │ │ └── index.ts │ │ ├── scheduled-tasks/ │ │ │ ├── List.tsx │ │ │ └── index.ts │ │ ├── statistics/ │ │ │ ├── DatabaseRooms.tsx │ │ │ ├── UserMedia.tsx │ │ │ └── index.ts │ │ └── users/ │ │ ├── Create.tsx │ │ ├── Edit.tsx │ │ ├── List.tsx │ │ └── index.ts │ ├── utils/ │ │ ├── config.test.ts │ │ ├── config.ts │ │ ├── date.test.ts │ │ ├── date.ts │ │ ├── error.test.ts │ │ ├── error.ts │ │ ├── fetchMedia.test.ts │ │ ├── fetchMedia.ts │ │ ├── formatBytes.test.ts │ │ ├── formatBytes.ts │ │ ├── icons.ts │ │ ├── logger.test.ts │ │ ├── logger.ts │ │ ├── mxid.test.ts │ │ ├── mxid.ts │ │ ├── password.test.ts │ │ ├── password.ts │ │ ├── safety.test.ts │ │ ├── safety.ts │ │ ├── version.test.ts │ │ └── version.ts │ └── vitest.setup.ts ├── tsconfig.json └── vite.config.ts ================================================ FILE CONTENTS ================================================ ================================================ FILE: .dockerignore ================================================ /docs/testdata ================================================ FILE: .editorconfig ================================================ # EditorConfig https://EditorConfig.org # top-most EditorConfig file root = true [*] charset = utf-8 end_of_line = lf indent_size = 2 indent_style = space insert_final_newline = true max_line_length = 120 trim_trailing_whitespace = true ================================================ FILE: .gitattributes ================================================ yarn*.cjs binary ================================================ FILE: .github/CONTRIBUTING.md ================================================ # Contribution Guidelines Table of Contents: * [Did you find a bug?](#did-you-find-a-bug) * [Is it a Security Vulnerability?](#is-it-a-security-vulnerability) * [Is it already a known issue?](#is-it-already-a-known-issue) * [Reporting a Bug](#reporting-a-bug) * [Is there a patch for the bug?](#is-there-a-patch-for-the-bug) * [Do you want to add a new feature?](#do-you-want-to-add-a-new-feature) * [Is it just an idea?](#is-it-just-an-idea) * [Is there a patch for the feature?](#is-there-a-patch-for-the-feature) * [Do you have questions about the Ketesa project or need guidance?](#do-you-have-questions-about-the-ketesa-project-or-need-guidance) ## Did you find a bug? ### Is it a Security Vulnerability? Please follow the [Security Policy](https://github.com/etkecc/ketesa/blob/main/.github/SECURITY.md) for reporting security vulnerabilities. ### Is it already a known issue? Please ensure the bug was not already reported by searching [the Issues section](https://github.com/etkecc/ketesa/issues). ### Reporting a Bug If you think you have found a bug in Ketesa, it is not a security vulnerability, and it is not already reported, please open [a new issue](https://github.com/etkecc/ketesa/issues/new) with: * A proper title and clear description of the problem. * As much relevant information as possible: * The version of Ketesa you are using. * The version of Synapse you are using. * Any relevant browser console logs, failed requests details, and error messages. ### Is there a patch for the bug? If you already have a patch for the bug, please open a pull request with the patch, and mention the issue number in the pull request description. ## Do you want to add a new feature? ### Is it just an idea? Please open [a new issue](https://github.com/etkecc/ketesa/issues/new) with: * A proper title and clear description of the requested feature. * Any relevant information about the feature: * Why do you think this feature is needed? * How do you think it should work? (provide Ketesa API endpoint) * Any relevant screenshots or mockups. ### Is there a patch for the feature? If you already have a patch for the feature, please open a pull request with the patch, and mention the issue number in the pull request description. ## Do you have questions about the Ketesa project or need guidance? Please use the official community Matrix room: [#ketesa:etke.cc](https://matrix.to/#/#ketesa:etke.cc) ================================================ FILE: .github/ISSUE_TEMPLATE/bug_report.md ================================================ --- name: Bug report about: Report a Ketesa bug title: '' labels: bug assignees: '' --- **Describe the bug** A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error **Expected behavior** A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. **Browser console logs** If applicable, add the browser console's log **Instance configuration:** - Ketesa version: [e.g. v0.10.3-etke39] - Synapse version [v1.127.1] **Additional context** Add any other context about the problem here. ================================================ FILE: .github/ISSUE_TEMPLATE/feature_request.md ================================================ --- name: Feature request about: Suggest an idea for Ketesa title: '' labels: enhancement assignees: '' --- **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] **Describe the solution you'd like** A clear and concise description of what you want to happen. **Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. **Provide related Synapse Admin API endpoints** If applicable, provide links to the Synapse Admin API's endpoints that could be used to implement that feature **Additional context** Add any other context or screenshots about the feature request here. ================================================ FILE: .github/SECURITY.md ================================================ # Security Policy ## Supported Versions Only [the last published version](https://github.com/etkecc/ketesa/releases/latest) of the project is supported. This means that only the latest version will receive security updates. If you are using an older version, you are strongly encouraged to upgrade to the latest version. ## Reporting a Vulnerability Please contact us using the [#ketesa:etke.cc](https://matrix.to/#/#ketesa:etke.cc) Matrix room. Ketesa is a static JS UI for Matrix servers, so it is unlikely that there are (or will be) any impactful security vulnerabilities in the project itself. However, we do not rule out the possibility of such cases, so we will be happy to receive any reports! ================================================ FILE: .github/dependabot.yml ================================================ version: 2 updates: - package-ecosystem: "npm" directory: "/" schedule: interval: "weekly" open-pull-requests-limit: 30 - package-ecosystem: "docker" directory: "/" schedule: interval: "weekly" open-pull-requests-limit: 30 - package-ecosystem: "github-actions" directory: "/" schedule: interval: "weekly" open-pull-requests-limit: 30 ================================================ FILE: .github/workflows/reuse.yml ================================================ --- name: REUSE Compliance Check on: [push, pull_request] permissions: contents: read jobs: reuse-compliance-check: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v6 - name: REUSE Compliance Check uses: fsfe/reuse-action@676e2d560c9a403aa252096d99fcab3e1132b0f5 # v6.0.0 ================================================ FILE: .github/workflows/workflow.yml ================================================ name: CI on: push: branches: [ "main" ] tags: [ "v*" ] env: bunny_version: v0.1.0 base_path: ./ NODE_OPTIONS: --max_old_space_size=4096 permissions: checks: write contents: write packages: write pull-requests: read jobs: build: name: Build runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 with: fetch-depth: 0 - uses: actions/setup-node@v6 with: node-version: lts/* cache: yarn - name: Install dependencies run: yarn install --immutable --network-timeout=300000 --pure-lockfile - name: Build run: | yarn build --base=${{ env.base_path }} mv dist dist-root yarn build --base=/admin/ mv dist dist-subpath-admin env: NODE_ENV: production - uses: actions/upload-artifact@v7 with: path: dist-root/ name: dist-root if-no-files-found: error retention-days: 1 compression-level: 0 overwrite: true include-hidden-files: true - uses: actions/upload-artifact@v7 with: path: dist-subpath-admin/ name: dist-subpath-admin if-no-files-found: error retention-days: 1 compression-level: 0 overwrite: true include-hidden-files: true docker: name: Docker needs: build runs-on: self-hosted steps: - uses: actions/checkout@v6 - uses: actions/download-artifact@v8 with: name: dist-root path: dist/ - name: Set up Docker Buildx uses: docker/setup-buildx-action@4d04d5d9486b7bd6fa91e7baf45bbb4f8b9deedd # v4.0.0 - name: Login to ghcr.io uses: docker/login-action@4907a6ddec9925e35a0a9e82d7399ccc52663121 # v4.1.0 with: registry: ghcr.io username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} - name: Login to hub.docker.com uses: docker/login-action@4907a6ddec9925e35a0a9e82d7399ccc52663121 # v4.1.0 with: username: etkecc password: ${{ secrets.DOCKERHUB_TOKEN }} - name: Extract metadata (tags, labels) for Docker id: meta uses: docker/metadata-action@030e881283bb7a6894de51c315a6bfe6a94e05cf # v6.0.0 with: images: | ${{ github.repository }} etkecc/synapse-admin ghcr.io/${{ github.repository }} registry.etke.cc/${{ github.repository }} tags: | type=raw,value=latest,enable=${{ github.ref_name == 'main' }} type=semver,pattern={{raw}} type=match,pattern=^v([0-9]+)\..*$,group=1,prefix=v,enable=${{ startsWith(github.ref, 'refs/tags/') }} - name: Build and push uses: docker/build-push-action@bcafcacb16a39f128d818304e6c9c0c18556b85f # v7.1.0 with: platforms: linux/amd64,linux/arm64 context: . push: true file: docker/Dockerfile tags: ${{ steps.meta.outputs.tags }} labels: ${{ steps.meta.outputs.labels }} build-args: | VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }} VCS_REF=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.revision'] }} BUILD_DATE=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }} docker-subpath-admin: name: Docker (subpath /admin) needs: build runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 - uses: actions/download-artifact@v8 with: name: dist-subpath-admin path: dist/ - name: Set up Docker Buildx uses: docker/setup-buildx-action@4d04d5d9486b7bd6fa91e7baf45bbb4f8b9deedd # v4.0.0 - name: Login to ghcr.io uses: docker/login-action@4907a6ddec9925e35a0a9e82d7399ccc52663121 # v4.1.0 with: registry: ghcr.io username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} - name: Login to hub.docker.com uses: docker/login-action@4907a6ddec9925e35a0a9e82d7399ccc52663121 # v4.1.0 with: username: etkecc password: ${{ secrets.DOCKERHUB_TOKEN }} - name: Extract metadata (tags, labels) for Docker id: meta uses: docker/metadata-action@030e881283bb7a6894de51c315a6bfe6a94e05cf # v6.0.0 with: images: | ${{ github.repository }} etkecc/synapse-admin ghcr.io/${{ github.repository }} tags: | type=raw,value=latest-subpath-admin,enable=${{ github.ref_name == 'main' }} type=semver,pattern={{raw}}-subpath-admin - name: Build and push uses: docker/build-push-action@bcafcacb16a39f128d818304e6c9c0c18556b85f # v7.1.0 with: platforms: linux/amd64,linux/arm64 context: . push: true file: docker/Dockerfile.subpath-admin tags: ${{ steps.meta.outputs.tags }} labels: ${{ steps.meta.outputs.labels }} build-args: | VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }} VCS_REF=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.revision'] }} BUILD_DATE=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }} cdn: name: CDN needs: build runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 - uses: actions/download-artifact@v8 with: name: dist-root path: dist/ - name: Upload run: | wget -O bunny-upload.tar.gz https://github.com/etkecc/bunny-upload/releases/download/${{ env.bunny_version }}/bunny-upload_Linux_x86_64.tar.gz tar -xzf bunny-upload.tar.gz echo "${{ secrets.BUNNY_CONFIG }}" > bunny-config.yaml sed -i "s|
|${{ secrets.CDN_HEAD }}|g" dist/index.html sed -i "s||${{ secrets.CDN_HEAD }}|g" dist/auth-callback/index.html rm dist/robots.txt ./bunny-upload -c bunny-config.yaml github-release: name: Github Release needs: build if: ${{ startsWith(github.ref, 'refs/tags/') }} runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 - uses: actions/download-artifact@v8 with: name: dist-root path: dist-root/ - uses: actions/download-artifact@v8 with: name: dist-subpath-admin path: dist-subpath-admin/ - name: Prepare release run: | mv dist-root ketesa tar chvzf ketesa.tar.gz ketesa mv dist-subpath-admin ketesa-subpath-admin tar chvzf ketesa-subpath-admin.tar.gz ketesa-subpath-admin - uses: softprops/action-gh-release@b4309332981a82ec1c5618f44dd2e27cc8bfbfda # v3.0.0 with: files: | ketesa.tar.gz ketesa-subpath-admin.tar.gz generate_release_notes: true make_latest: "true" draft: false prerelease: false ================================================ FILE: .gitignore ================================================ # Created by https://www.toptal.com/developers/gitignore/api/node,yarn,react,visualstudiocode # Edit at https://www.toptal.com/developers/gitignore?templates=node,yarn,react,visualstudiocode ## local state docs/apis/* docs/testdata/postgres.data docs/testdata/synapse.data ### Node ### # Logs logs *.log npm-debug.log* yarn-debug.log* yarn-error.log* lerna-debug.log* .pnpm-debug.log* # Diagnostic reports (https://nodejs.org/api/report.html) report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json # Runtime data pids *.pid *.seed *.pid.lock # Directory for instrumented libs generated by jscoverage/JSCover lib-cov # Coverage directory used by tools like istanbul coverage *.lcov # nyc test coverage .nyc_output # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) .grunt # Bower dependency directory (https://bower.io/) bower_components # node-waf configuration .lock-wscript # Compiled binary addons (https://nodejs.org/api/addons.html) build/Release # Dependency directories node_modules/ jspm_packages/ # Snowpack dependency directory (https://snowpack.dev/) web_modules/ # TypeScript cache *.tsbuildinfo # Optional npm cache directory .npm # Optional eslint cache .eslintcache # Optional stylelint cache .stylelintcache # Microbundle cache .rpt2_cache/ .rts2_cache_cjs/ .rts2_cache_es/ .rts2_cache_umd/ # Optional REPL history .node_repl_history # Output of 'npm pack' *.tgz # Yarn Integrity file .yarn-integrity # dotenv environment variable files .env .env.development.local .env.test.local .env.production.local .env.local # parcel-bundler cache (https://parceljs.org/) .cache .parcel-cache # Next.js build output .next out # Nuxt.js build / generate output .nuxt dist # Gatsby files .cache/ # Comment in the public line in if your project uses Gatsby and not Next.js # https://nextjs.org/blog/next-9-1#public-directory-support # public # vuepress build output .vuepress/dist # vuepress v2.x temp and cache directory .temp # Docusaurus cache and generated files .docusaurus # Serverless directories .serverless/ # FuseBox cache .fusebox/ # DynamoDB Local files .dynamodb/ # TernJS port file .tern-port # Stores VSCode versions used for testing VSCode extensions .vscode-test # yarn v2 .yarn .pnp.* ### Node Patch ### # Serverless Webpack directories .webpack/ # Optional stylelint cache # SvelteKit build / generate output .svelte-kit ### react ### .DS_* **/*.backup.* **/*.back.* node_modules *.sublime* psd thumb sketch ### VisualStudioCode ### .vscode/* !.vscode/settings.json !.vscode/tasks.json !.vscode/launch.json !.vscode/extensions.json !.vscode/*.code-snippets # Local History for Visual Studio Code .history/ # Built Visual Studio Code Extensions *.vsix ### VisualStudioCode Patch ### # Ignore all local history of files .history .ionide ### yarn ### # https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored .yarn/* # End of https://www.toptal.com/developers/gitignore/api/node,yarn,react,visualstudiocode ================================================ FILE: .prettierignore ================================================ .vscode .yarn **/*.md **/*.woff2 ================================================ FILE: .watchmanconfig ================================================ { "ignore_dirs": ["docs/testdata"] } ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS ================================================ FILE: LICENSES/Apache-2.0.txt ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: LICENSES/BSD-2-Clause.txt ================================================ Copyright (c) <
The evolution of Synapse Admin. Manage, monitor, and maintain your Matrix homeserver from one clean interface. Built for small private servers and large federated communities alike. Formerly Synapse Admin.
---   [View all screenshots →](./docs/screenshots/README.md) ## 📖 About Ketesa is the evolution of Synapse Admin — a fully independent admin interface for Matrix homeservers. What began as a fork of [Awesome-Technologies/synapse-admin](https://github.com/Awesome-Technologies/synapse-admin) has grown into its own project, with a redesigned interface, comprehensive API coverage, multi-language support, and powerful management tools that go far beyond the original. **Ketesa is a fully compatible drop-in replacement for Synapse Admin.** Migration is straightforward and requires no configuration changes: | | Method | How | |---|---|---| | ☁️ | **Hosted (CDN)** | Use [admin.etke.cc](https://admin.etke.cc) — nothing to install | | 🐳 | **Docker** | Replace the image tag with `ghcr.io/etkecc/ketesa:latest` | | 📦 | **Static files** | Replace your existing dist directory with the Ketesa release tarball | Whether you're managing a small private server or a large federated community, Ketesa gives you the visibility and control you need — all from a clean, responsive web interface. > 💬 Questions? Join the [community room](https://matrix.to/#/#ketesa:etke.cc) or open an issue on GitHub. --- ## ✨ Features ### 👥 Complete user management Ketesa covers the full lifecycle of a Matrix user account. You can suspend, [shadow-ban](./docs/user-management.md#-shadow-ban), [deactivate, or permanently erase](./docs/user-management.md#-deactivation-vs-erasure) users. Fine-grained controls let you manage [rate limits](./docs/user-management.md#-rate-limits), [experimental features](./docs/user-management.md#-experimental-features), and [account data](./docs/user-management.md#-account-data). You can view and manage third-party identifiers, connected devices (create, rename, delete), room memberships, and cross-signing keys — all from one place. Need to onboard many users at once? [Bulk registration via CSV import](./docs/csv-import.md) handles it, including third-party identifiers. Passwords can be generated randomly or reset manually. User avatars carry [role badges](./docs/user-badges.md) (admin, bot, support, federated, system-managed) so you can identify account types at a glance. When [Matrix Authentication Service (MAS)](https://github.com/element-hq/matrix-authentication-service) is in use, Ketesa extends user management with [MAS-native capabilities](./docs/user-management.md#-mas-user-management): browsing and revoking active sessions (compat, OAuth2, and personal), managing linked email addresses, reviewing upstream OAuth provider links, and creating users through MAS directly. [📄 User management guide](./docs/user-management.md) ### 🏠 Powerful room management Get a full picture of every room on your server. Block or unblock rooms, purge history, and delete rooms entirely. The [messages viewer](./docs/room-management.md#-messages-viewer) lets you browse room history with filters and jump-to-date navigation. [Spaces are handled natively](./docs/room-management.md#-room-hierarchy) with a dedicated room hierarchy tab. You can assign room admins and join users to rooms directly from the UI. [Media](./docs/media.md) can be quarantined, protected, or deleted at file, user, or room scope. [📄 Room management guide](./docs/room-management.md) · [📄 Media management guide](./docs/media.md) ### 🔐 Flexible authentication Log in with a username and password, a raw access token, or via OIDC/SSO — whatever your server setup requires. Ketesa has first-class support for [Matrix Authentication Service (MAS)](https://github.com/element-hq/matrix-authentication-service), including full session management and [registration token administration](./docs/registration-tokens.md). It also ships a dedicated [external auth provider mode](./docs/external-auth-provider.md) that adapts the interface when Synapse delegates authentication to an external system. [📄 Registration tokens guide](./docs/registration-tokens.md) ### ⚙️ Deep customization Every data table in Ketesa is built with [react-admin's Configurable](https://marmelab.com/react-admin/Configurable.html) component, so users can show, hide, and reorder columns to match their workflow — no code changes needed. [📄 Configurable columns guide](./docs/configurable-columns.md) Beyond the per-user table preferences, Ketesa can be tailored at the deployment level through a [`config.json`](./docs/config.md) file (or via `/.well-known/matrix/client`): [restrict which homeservers](./docs/restrict-hs.md) users can connect to, [add custom navigation menu items](./docs/custom-menu.md), [pre-fill the login form](./docs/prefill-login-form.md), [configure CORS credentials](./docs/cors-credentials.md), and [protect appservice-managed users](./docs/system-users.md) (bridge puppets) from accidental edits. ### 📊 Server statistics and insights Monitor your server with built-in statistics views: [per-user media usage and database room stats](./docs/server-statistics.md) give you a clear picture of what's consuming space. The [federation overview](./docs/federation.md) shows the health and reachability of remote destinations. [Reported events](./docs/event-reports.md) can be reviewed and acted upon directly from the reports list. [📄 Server statistics guide](./docs/server-statistics.md) · [📄 Federation guide](./docs/federation.md) · [📄 Event reports guide](./docs/event-reports.md) ### 🌍 Available in 10 languages Ketesa ships with full translations in English, German, French, Japanese, Russian, Persian, Ukrainian, Chinese, Italian, and Portuguese — every string is fully translated, with no untranslated English stubs left behind. ### 📱 Mobile-friendly by design The interface is fully responsive. Wherever you are, you can manage your server from a phone or tablet without sacrificing functionality. Tables collapse to readable mobile lists, long identifiers wrap gracefully, and every action is reachable on small screens. ### 🌟 Built by etke.cc — and it shows Ketesa is built and actively maintained by [etke.cc](https://etke.cc/?utm_source=github&utm_medium=readme&utm_campaign=ketesa), a managed Matrix hosting provider with a genuine [open-source-first](https://github.com/etkecc) philosophy. Every feature in this project is open source, developed in the open, and free to use by anyone. If you run your Matrix server on etke.cc, Ketesa becomes something even more powerful: a **unified control plane for your entire server**. Instead of juggling separate dashboards, log files, and support channels, everything you need is right here — in the same interface you already use for user and room management: | | Feature | What it does | |---|---|---| | 🟢 | **Server health** | Live status badge in the toolbar + a full dashboard showing every server component with color-coded indicators, error details, and suggested actions. Know what's wrong before your users do. | | 🔔 | **Notifications** | Important server events surface as an in-app feed with an unread badge — nothing slips through the cracks. | | ⚡ | **Server actions** | Trigger management commands on demand, schedule them for a precise date and time, or set up recurring weekly jobs. Routine maintenance becomes a few clicks, not a cron job. | | 🧩 | **Components** | Browse, add, and remove server add-ons — bridges, bots, apps — from a self-service catalogue. See what's active, preview the cost impact, and request changes with one click. | | 💳 | **Billing** | View payment history, transaction details, and download invoices without ever leaving the admin panel. | | 💬 | **Support** | Open support requests, track their progress, and exchange messages with the etke.cc support — right from the interface you use every day. | | 🎨 | **White-labelling** | Custom name, logo, favicon, and background applied automatically from the platform. No extra configuration, no deploy step. | > 💡 **Interested?** [Learn more about etke.cc managed Matrix hosting →](https://etke.cc/?utm_source=github&utm_medium=readme&utm_campaign=ketesa) --- ## 📦 Availability | | Where | Details | |---|---|---| | 🏠 | **[etke.cc](https://etke.cc/?utm_source=github&utm_medium=readme&utm_campaign=ketesa)** | Managed hosting with Ketesa built in | | 🌐 | **[admin.etke.cc](https://admin.etke.cc)** | Hosted instance, always on the latest development version | | 📦 | **[GitHub Releases](https://github.com/etkecc/ketesa/releases)** | Official prebuilt tarballs for root-path and `/admin` deployments | | 🐳 | **[GHCR](https://github.com/etkecc/ketesa/pkgs/container/ketesa) / [Docker Hub](https://hub.docker.com/r/etkecc/ketesa/tags)** | Official container images | | 🔧 | **[Source](https://github.com/etkecc/ketesa)** | Build from source or track `main` directly | Official static builds: - **`ketesa.tar.gz`** for root path deployment, such as `https://admin.example.com` - **`ketesa-subpath-admin.tar.gz`** for `/admin` deployments, such as `https://example.com/admin` For nightly builds, distro packages, Ansible integrations, and IPFS, see the [full availability guide](./docs/availability.md). --- ## ⚙️ Configuration Ketesa can be configured via a `config.json` file placed in the deployment root. Additionally, your homeserver's `/.well-known/matrix/client` file can carry Ketesa-specific configuration under the `cc.etke.ketesa` key — any instance of Ketesa will pick it up automatically, making it easy to distribute settings to your users without touching the deployment itself. Settings in `/.well-known/matrix/client` take precedence over `config.json`. > **Note:** The legacy key `cc.etke.synapse-admin` is still supported for backward compatibility, but is deprecated. > Please migrate to `cc.etke.ketesa` at your convenience. If you use [spantaleev/matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy) or [etkecc/ansible](https://github.com/etkecc/ansible), configuration is automatically written to `/.well-known/matrix/client` for you. [📄 Full configuration reference](./docs/config.md) To inject a `config.json` into a Docker container, use a bind mount: ```yml services: ketesa: ... volumes: - ./config.json:/var/public/config.json:ro ... ``` ### 🔗 Prefilling the login form Every field on the login page can be pre-filled via URL query parameters — handy for sharing direct-access links with your users. [Documentation](./docs/prefill-login-form.md) ### 🔒 Restricting available homeservers Lock down the homeserver selection so users can only connect to servers you approve. Useful for managed deployments where the homeserver should never change. [Documentation](./docs/restrict-hs.md) ### 🌐 Configuring CORS credentials Fine-tune the CORS credentials mode for your Ketesa deployment to match your server's cross-origin policies. [Documentation](./docs/cors-credentials.md) ### 🛡️ Protecting appservice-managed users Bridge puppets and other appservice-managed accounts can be shielded from accidental edits. Specify a list of MXID patterns (as regular expressions) to be restricted to display name and avatar changes only. [Documentation](./docs/system-users.md) ### 📋 Adding custom menu items Extend the navigation menu with links to your own tools or documentation — no rebuild required. [Documentation](./docs/custom-menu.md) ### 🔑 External auth provider mode When Synapse delegates authentication to an external provider (OIDC, LDAP, and similar), enable this mode to adjust Ketesa's behavior accordingly and avoid confusing UI elements that don't apply in your setup. [Documentation](./docs/external-auth-provider.md) #### Matrix Authentication Service (MAS) MAS requires a small amount of additional configuration to enable its admin API. See the [designated MAS section](./docs/external-auth-provider.md#matrix-authentication-service-mas) for the details. --- ## 🚀 Usage ### Supported APIs See [📄 Supported APIs](./docs/apis.md) for a full list of API endpoints used by Ketesa. ### Supported Synapse versions Ketesa requires [Synapse](https://github.com/element-hq/synapse) **v1.150.0 or newer** for all features to work correctly. You can verify your server version by calling `/_synapse/admin/v1/server_version`, or simply look at the version indicator that appears below the homeserver URL field on the Ketesa login page. See also: [Synapse version API](https://element-hq.github.io/synapse/latest/admin_api/version_api.html) ### Prerequisites Your browser needs access to the following endpoints on your homeserver: - `/_matrix` - `/_synapse/admin` See also: [Synapse administration endpoints](https://element-hq.github.io/synapse/latest/reverse_proxy.html#synapse-administration-endpoints) ### ☁️ Use without installing anything The hosted version at [admin.etke.cc](https://admin.etke.cc) is always up to date and requires no installation. Just open it in your browser, enter your homeserver URL, and log in with your admin account. > 🔒 Your browser must be able to reach `/_synapse/admin` on your homeserver. The endpoints > do not need to be exposed to the public internet — access from your local network is sufficient. ### 📥 Step-by-step installation Choose your preferred method: | | Method | Best for | |---|---|---| | [1️⃣](#steps-for-1) | **Tarball + webserver** | Any static hosting, full control | | [2️⃣](#steps-for-2) | **Source + Node.js** | Development or custom builds | | [3️⃣](#steps-for-3) | **Docker** | Containerized deployments | #### Steps for 1) - Make sure you have a webserver installed that can serve static files (nginx, Apache, Caddy, or anything else will work) - Configure a virtual host for Ketesa on your webserver - Download the appropriate `.tar.gz` from the [latest release](https://github.com/etkecc/ketesa/releases/latest): - `ketesa.tar.gz` for root path deployment (e.g., `https://admin.example.com`) - `ketesa-subpath-admin.tar.gz` for `/admin` subpath deployment (e.g., `https://example.com/admin`) - Unpack the archive and place the contents in your virtual host's document root - Open the URL in your browser [📄 Reverse proxy configuration examples](./docs/reverse-proxy.md) #### Steps for 2) - Make sure you have git, yarn, and Node.js installed - Clone the repository: `git clone https://github.com/etkecc/ketesa.git` - Enter the directory: `cd ketesa` - Install dependencies: `yarn install` - Start the development server: `yarn start` #### Steps for 3) - Run the Docker container: `docker run -p 8080:8080 ghcr.io/etkecc/ketesa` Or use the provided [docker-compose.yml](docker/docker-compose.yml): ```sh docker-compose -f docker/docker-compose.yml up -d ``` > **Note:** If you're building on a non-amd64 architecture (e.g., Raspberry Pi), set a Node.js > memory cap to prevent OOM failures during the build: `NODE_OPTIONS="--max_old_space_size=1024"`. > **Note:** On IPv4-only systems, set `SERVER_HOST=0.0.0.0` so Ketesa binds correctly. To build your own image from source: ```yml services: ketesa: container_name: ketesa hostname: ketesa build: context: https://github.com/etkecc/ketesa.git dockerfile: docker/Dockerfile.build args: - BUILDKIT_CONTEXT_KEEP_GIT_DIR=1 # - NODE_OPTIONS="--max_old_space_size=1024" # - BASE_PATH="/ketesa" ports: - "8080:8080" restart: unless-stopped ``` - Open http://localhost:8080 in your browser ### 🛤️ Serving Ketesa under a custom path The base path is baked in at build time and cannot be changed at runtime. - For `/admin` specifically: use the prebuilt `ketesa-subpath-admin` tarball from [GitHub Releases](https://github.com/etkecc/ketesa/releases) or the `dist-subpath-admin` artifact from [GitHub Actions](https://github.com/etkecc/ketesa/actions/workflows/workflow.yml), or the `*-subpath-admin` Docker image tag. - For root path: use `ketesa.tar.gz` or the `dist-root` artifact. - For any other prefix: build from source with `yarn build --base=/my-prefix`, or pass the `BASE_PATH` build argument to Docker. If you need a reverse proxy to expose Ketesa under a different base path without rebuilding, here is a Traefik example: `docker-compose.yml` ```yml services: traefik: image: traefik:v3 restart: unless-stopped ports: - 80:80 - 443:443 volumes: - /var/run/docker.sock:/var/run/docker.sock:ro ketesa: image: ghcr.io/etkecc/ketesa:latest restart: unless-stopped labels: - "traefik.enable=true" - "traefik.http.routers.admin.rule=Host(`example.com`) && PathPrefix(`/admin`)" - "traefik.http.services.admin.loadbalancer.server.port=8080" - "traefik.http.middlewares.admin-slashless-redirect.redirectregex.regex=(/admin)$$" - "traefik.http.middlewares.admin-slashless-redirect.redirectregex.replacement=$${1}/" - "traefik.http.middlewares.admin-strip-prefix.stripprefix.prefixes=/admin" - "traefik.http.routers.admin.middlewares=admin-slashless-redirect,admin-strip-prefix" ``` --- ## 🛠️ Development - See https://yarnpkg.com/getting-started/editor-sdks for IDE setup instructions | Command | What it does | |---|---| | `yarn lint` | Run all style and linter checks | | `yarn test` | Run all unit tests | | `yarn fix` | Auto-fix coding style issues | | `just run-dev` | Spin up the full local development stack | `just run-dev` launches a complete local environment: a Synapse homeserver, Element Web, and a Postgres database. The app starts in development mode at `http://localhost:5173`. (If user creation fails on first run, re-run the command — the server may still be starting up.) Open [http://localhost:5173](http://localhost:5173?username=admin&password=admin&server=http://localhost:8008) and log in with: | Field | Value | |---|---| | Login | `admin` | | Password | `admin` | | Homeserver URL | `http://localhost:8008` | Element Web is available at http://localhost:8080. ================================================ FILE: REUSE.toml ================================================ version = 1 [[annotations]] path = ["**"] SPDX-FileCopyrightText = [ "2018-2023 Awesome Technologies Innovationslabor GmbH", "2024-2026 etke.cc team