From c9bafd9af27250f1227ec39ab21cfce4bec6d236 Mon Sep 17 00:00:00 2001 From: Tomas Kracmar Date: Wed, 27 Mar 2024 14:10:04 +0100 Subject: [PATCH] Update ma1sd to mxids --- Dockerfile | 2 +- DockerfileX | 4 +-- build.gradle | 2 +- docs/architecture.md | 2 +- ma1sd.example.yaml => mxids.example.yaml | 28 +++++++++---------- src/debian/control | 4 +-- src/debian/postinst | 14 +++++----- src/debian/prerm | 6 ++-- src/docker/start.sh | 4 +-- .../io/kamax/mxisd/MxisdStandaloneExec.java | 14 +++++----- .../mxisd/config/rest/RestBackendConfig.java | 14 +++++----- .../exception/TermsNotSignedException.java | 4 +-- .../InternalInviteManagerHandler.java | 2 +- src/script/{ma1sd => mxids} | 10 +++---- src/systemd/ma1sd.service | 10 ------- src/systemd/mxids.service | 10 +++++++ 16 files changed, 65 insertions(+), 65 deletions(-) rename ma1sd.example.yaml => mxids.example.yaml (92%) rename src/script/{ma1sd => mxids} (96%) delete mode 100644 src/systemd/ma1sd.service create mode 100644 src/systemd/mxids.service diff --git a/Dockerfile b/Dockerfile index c778efd..428f019 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,7 +2,7 @@ FROM --platform=$BUILDPLATFORM openjdk:8-jre-alpine AS builder RUN apk update && apk add gradle git && rm -rf /var/lib/apk/* /var/cache/apk/* -WORKDIR /ma1sd +WORKDIR /mxids COPY . . RUN ./gradlew shadowJar diff --git a/DockerfileX b/DockerfileX index 20ecfdd..e9e8d88 100644 --- a/DockerfileX +++ b/DockerfileX @@ -1,7 +1,7 @@ FROM --platform=$BUILDPLATFORM openjdk:11.0.16-jre-slim -VOLUME /etc/ma1sd -VOLUME /var/ma1sd +VOLUME /etc/mxids +VOLUME /var/mxids EXPOSE 8090 ENV JAVA_OPTS="" diff --git a/build.gradle b/build.gradle index 6c79da4..a8821ff 100644 --- a/build.gradle +++ b/build.gradle @@ -52,7 +52,7 @@ mainClassName = 'io.kamax.mxisd.MxisdStandaloneExec' sourceCompatibility = '1.8' targetCompatibility = '1.8' -String ma1sdVersion() { +String mxidsVersion() { def versionPattern = Pattern.compile("v(\\d+\\.)?(\\d+\\.)?(\\d+)(-.*)?") String version = System.getenv('MXIDS_BUILD_VERSION') diff --git a/docs/architecture.md b/docs/architecture.md index 212d6bb..b8595b2 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -16,7 +16,7 @@ TCP 443 +<---------------------------------<+ | | +-------------------+ - TCP 8090 +-> | ma1sd | + TCP 8090 +-> | mxids | | | | - Profile's 3PIDs | | - 3PID Invites | diff --git a/ma1sd.example.yaml b/mxids.example.yaml similarity index 92% rename from ma1sd.example.yaml rename to mxids.example.yaml index 563b961..9bd81a4 100644 --- a/ma1sd.example.yaml +++ b/mxids.example.yaml @@ -21,7 +21,7 @@ # matrix: domain: '' - v1: true # deprecated + v1: false # deprecated v2: true # MSC2140 API v2. Riot require enabled V2 API. @@ -32,11 +32,11 @@ matrix: # /!\ THIS MUST **NOT** BE YOUR HOMESERVER KEYS FILE /!\ # If this path does not exist, it will be auto-generated. # -# During testing, /var/tmp/ma1sd/keys is a possible value +# During testing, /var/tmp/mxids/keys is a possible value # For production, recommended location shall be one of the following: -# - /var/lib/ma1sd/keys -# - /var/opt/ma1sd/keys -# - /var/local/ma1sd/keys +# - /var/lib/mxids/keys +# - /var/opt/mxids/keys +# - /var/local/mxids/keys # key: path: '' @@ -46,20 +46,20 @@ key: # /!\ THIS MUST **NOT** BE YOUR HOMESERVER DATABASE /!\ # # Examples: -# - /var/opt/ma1sd/store.db -# - /var/local/ma1sd/store.db -# - /var/lib/ma1sd/store.db +# - /var/opt/mxids/store.db +# - /var/local/mxids/store.db +# - /var/lib/mxids/store.db # storage: # backend: sqlite # or postgresql provider: sqlite: - database: '/path/to/ma1sd.db' + database: '/path/to/mxids.db' # postgresql: # # Wrap all string values with quotes to avoid yaml parsing mistakes -# database: '//localhost/ma1sd' # or full variant //192.168.1.100:5432/ma1sd_database -# username: 'ma1sd_user' -# password: 'ma1sd_password' +# database: '//localhost/mxids' # or full variant //192.168.1.100:5432/mxids_database +# username: 'mxids_user' +# password: 'mxids_password' # # # Pool configuration for postgresql backend. # ####### @@ -190,10 +190,10 @@ threepid: # terms: # en: # lang # name: term name en # localized name -# url: https://ma1sd.host.tld/term_en.html # localized url +# url: https://mxids.host.tld/term_en.html # localized url # fe: # lang # name: term name fr # localized name -# url: https://ma1sd.host.tld/term_fr.html # localized url +# url: https://mxids.host.tld/term_fr.html # localized url # regexp: # - '/_matrix/identity/v2/account.*' # - '/_matrix/identity/v2/hash_details' diff --git a/src/debian/control b/src/debian/control index 6137f68..c0bcadb 100644 --- a/src/debian/control +++ b/src/debian/control @@ -1,6 +1,6 @@ -Package: ma1sd +Package: mxids Maintainer: ma1uta -Homepage: https://github.com/ma1uta/ma1sd +Homepage: https://git.cqre.net/cqrenet/mxids.git Description: Federated Matrix Identity Server Architecture: all Section: net diff --git a/src/debian/postinst b/src/debian/postinst index 3a06ed4..a01f03b 100755 --- a/src/debian/postinst +++ b/src/debian/postinst @@ -1,19 +1,19 @@ #!/bin/bash -e # Add service account -useradd -r ma1sd || true +useradd -r mxids || true # Set permissions for data directory -chown -R ma1sd:ma1sd %DEB_DATA_DIR% +chown -R mxids:mxids %DEB_DATA_DIR% -# Create symlink to ma1sd run script -ln -sfT /usr/lib/ma1sd/ma1sd /usr/bin/ma1sd +# Create symlink to mxids run script +ln -sfT /usr/lib/mxids/mxids /usr/bin/mxids # Enable systemd service -systemctl enable ma1sd.service +systemctl enable mxids.service -# If we already have a config file setup, we attempt to run ma1sd automatically +# If we already have a config file setup, we attempt to run mxids automatically # Specifically targeted at upgrades where the service needs to be restarted if [ -f "%DEB_CONF_FILE%" ]; then - systemctl restart ma1sd.service + systemctl restart mxids.service fi diff --git a/src/debian/prerm b/src/debian/prerm index bee08db..063ed34 100644 --- a/src/debian/prerm +++ b/src/debian/prerm @@ -1,10 +1,10 @@ #!/bin/bash # Stop running instance if needed -systemctl stop ma1sd.service +systemctl stop mxids.service # Disable service if exists -systemctl disable ma1sd.service +systemctl disable mxids.service # remove symlink -rm /usr/bin/ma1sd +rm /usr/bin/mxids diff --git a/src/docker/start.sh b/src/docker/start.sh index 1edaecf..b328a78 100755 --- a/src/docker/start.sh +++ b/src/docker/start.sh @@ -27,8 +27,8 @@ if [[ -n "$CONF_FILE_PATH" ]] && [ ! -f "$CONF_FILE_PATH" ]; then echo >> "$CONF_FILE_PATH" fi - echo "Starting ma1sd..." + echo "Starting mxids..." echo fi -exec java -jar /app/ma1sd.jar -c /etc/ma1sd/ma1sd.yaml +exec java -jar /app/mxids.jar -c /etc/mxids/mxids.yaml diff --git a/src/main/java/io/kamax/mxisd/MxisdStandaloneExec.java b/src/main/java/io/kamax/mxisd/MxisdStandaloneExec.java index 90aca61..7a4bc26 100644 --- a/src/main/java/io/kamax/mxisd/MxisdStandaloneExec.java +++ b/src/main/java/io/kamax/mxisd/MxisdStandaloneExec.java @@ -36,7 +36,7 @@ public class MxisdStandaloneExec { private static final Logger log = LoggerFactory.getLogger("App"); public static void main(String[] args) { - String logLevel = System.getenv("MA1SD_LOG_LEVEL"); + String logLevel = System.getenv("MXIDS_LOG_LEVEL"); if (StringUtils.isNotBlank(logLevel)) { System.setProperty("org.slf4j.simpleLogger.log.io.kamax.mxisd", logLevel); } @@ -59,8 +59,8 @@ public class MxisdStandaloneExec { System.out.println(" -c, --config Set the configuration file location"); System.out.println(" -v Increase log level (log more info)"); System.out.println(" -vv Further increase log level"); - System.out.println(" --dump Dump the full ma1sd configuration"); - System.out.println(" --dump-and-exit Dump the full ma1sd configuration and exit"); + System.out.println(" --dump Dump the full mxids configuration"); + System.out.println(" --dump-and-exit Dump the full mxids configuration and exit"); System.out.println(" "); System.exit(0); return; @@ -88,7 +88,7 @@ public class MxisdStandaloneExec { } if (Objects.isNull(cfg)) { - cfg = YamlConfigLoader.tryLoadFromFile("ma1sd.yaml").orElseGet(MxisdConfig::new); + cfg = YamlConfigLoader.tryLoadFromFile("mxids.yaml").orElseGet(MxisdConfig::new); } if (dump) { @@ -98,17 +98,17 @@ public class MxisdStandaloneExec { } } - log.info("ma1sd starting"); + log.info("mxids starting"); log.info("Version: {}", Mxisd.Version); HttpMxisd mxisd = new HttpMxisd(cfg); Runtime.getRuntime().addShutdownHook(new Thread(() -> { mxisd.stop(); - log.info("ma1sd stopped"); + log.info("mxids stopped"); })); mxisd.start(); - log.info("ma1sd started"); + log.info("mxids started"); } catch (ConfigurationException e) { log.error(e.getDetailedMessage()); log.error(e.getMessage()); diff --git a/src/main/java/io/kamax/mxisd/config/rest/RestBackendConfig.java b/src/main/java/io/kamax/mxisd/config/rest/RestBackendConfig.java index 1291531..8667019 100644 --- a/src/main/java/io/kamax/mxisd/config/rest/RestBackendConfig.java +++ b/src/main/java/io/kamax/mxisd/config/rest/RestBackendConfig.java @@ -33,8 +33,8 @@ public class RestBackendConfig { public static class IdentityEndpoints { - private String single = "/_ma1sd/backend/api/v1/identity/single"; - private String bulk = "/_ma1sd/backend/api/v1/identity/bulk"; + private String single = "/_mxids/backend/api/v1/identity/single"; + private String bulk = "/_mxids/backend/api/v1/identity/bulk"; public String getSingle() { return single; @@ -56,9 +56,9 @@ public class RestBackendConfig { public static class ProfileEndpoints { - private String displayName = "/_ma1sd/backend/api/v1/profile/displayName"; - private String threepids = "/_ma1sd/backend/api/v1/profile/threepids"; - private String roles = "/_ma1sd/backend/api/v1/profile/roles"; + private String displayName = "/_mxids/backend/api/v1/profile/displayName"; + private String threepids = "/_mxids/backend/api/v1/profile/threepids"; + private String roles = "/_mxids/backend/api/v1/profile/roles"; public String getDisplayName() { return displayName; @@ -88,8 +88,8 @@ public class RestBackendConfig { public static class Endpoints { - private String auth = "/_ma1sd/backend/api/v1/auth/login"; - private String directory = "/_ma1sd/backend/api/v1/directory/user/search"; + private String auth = "/_mxids/backend/api/v1/auth/login"; + private String directory = "/_mxids/backend/api/v1/directory/user/search"; private IdentityEndpoints identity = new IdentityEndpoints(); private ProfileEndpoints profile = new ProfileEndpoints(); diff --git a/src/main/java/io/kamax/mxisd/exception/TermsNotSignedException.java b/src/main/java/io/kamax/mxisd/exception/TermsNotSignedException.java index a63881d..cf832ce 100644 --- a/src/main/java/io/kamax/mxisd/exception/TermsNotSignedException.java +++ b/src/main/java/io/kamax/mxisd/exception/TermsNotSignedException.java @@ -1,8 +1,8 @@ /* - * ma1sd - Matrix Identity Server Daemon + * mxids - Matrix Identity Server Daemon * Copyright (C) 2020 Anatoliy SAblin * - * https://www.github.com/ma1uta/ma1sd/ + * https://git.cqre.net/cqrenet/mxids/ * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as diff --git a/src/main/java/io/kamax/mxisd/http/undertow/handler/internal/InternalInviteManagerHandler.java b/src/main/java/io/kamax/mxisd/http/undertow/handler/internal/InternalInviteManagerHandler.java index 3537276..94eaaa5 100644 --- a/src/main/java/io/kamax/mxisd/http/undertow/handler/internal/InternalInviteManagerHandler.java +++ b/src/main/java/io/kamax/mxisd/http/undertow/handler/internal/InternalInviteManagerHandler.java @@ -10,7 +10,7 @@ import java.util.concurrent.Executors; public class InternalInviteManagerHandler extends BasicHttpHandler { - public static final String PATH = "/_ma1sd/internal/admin/inv_manager"; + public static final String PATH = "/_mxids/internal/admin/inv_manager"; private final InvitationManager invitationManager; private final ExecutorService executors = Executors.newFixedThreadPool(1); diff --git a/src/script/ma1sd b/src/script/mxids similarity index 96% rename from src/script/ma1sd rename to src/script/mxids index ec550c8..cd6841a 100755 --- a/src/script/ma1sd +++ b/src/script/mxids @@ -2,7 +2,7 @@ ############################################################################## ## -## ma1sd start up script for UN*X +## mxids start up script for UN*X ## ############################################################################## @@ -21,10 +21,10 @@ while [ -h "$PRG" ] ; do done APP_HOME=`dirname "$PRG"` -APP_NAME="ma1sd" +APP_NAME="mxids" APP_BASE_NAME=`basename "$0"` -# Add default JVM options here. You can also use JAVA_OPTS and MA1SD_OPTS to pass JVM options to this script. +# Add default JVM options here. You can also use JAVA_OPTS and MXIDS_OPTS to pass JVM options to this script. DEFAULT_JVM_OPTS="" # Use the maximum available, or set MAX_FD != -1 to use that value. @@ -61,7 +61,7 @@ case "`uname`" in ;; esac -CLASSPATH=$APP_HOME/ma1sd.jar +CLASSPATH=$APP_HOME/mxids.jar # Determine the Java command to use to start the JVM. if [ -n "$JAVA_HOME" ] ; then @@ -158,7 +158,7 @@ for s in "${@}" ; do done # Collect JVM options -JVM_OPTS=$DEFAULT_JVM_OPTS" "$JAVA_OPTS" "$MA1SD_OPTS +JVM_OPTS=$DEFAULT_JVM_OPTS" "$JAVA_OPTS" "$MXIDS_OPTS # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then diff --git a/src/systemd/ma1sd.service b/src/systemd/ma1sd.service deleted file mode 100644 index 253138f..0000000 --- a/src/systemd/ma1sd.service +++ /dev/null @@ -1,10 +0,0 @@ -[Unit] -Description=ma1sd -After=syslog.target - -[Service] -User=ma1sd -ExecStart=/usr/bin/ma1sd -c /etc/ma1sd/ma1sd.yaml - -[Install] -WantedBy=multi-user.target diff --git a/src/systemd/mxids.service b/src/systemd/mxids.service new file mode 100644 index 0000000..cf7d6bc --- /dev/null +++ b/src/systemd/mxids.service @@ -0,0 +1,10 @@ +[Unit] +Description=mxids +After=syslog.target + +[Service] +User=mxids +ExecStart=/usr/bin/mxids -c /etc/mxids/mxids.yaml + +[Install] +WantedBy=multi-user.target