README.md

Java Electerm sync server

A simple electerm data sync server.

docker compose

version: '3'
services:
  electerm-sync-server:
    restart: on-failure
    image: aliangbaby/electerm-sync-server-java
    ports:
      #指定对外端口
      - 47837:7837
    volumes:
      #指定配置存储路径
      - /path/for/config:/app/config
    environment:
      #设置密钥，可以使用openssl rand -base64 32生成
      - JWT_SECRET=ChangeIt
      #用户名，可以多个，英文逗号分割
      - JWT_USERS=username

然后在设置同步中选择custom填入容器外网地址（http://xxx:47837/api/sync ） 和JWT信息

直接从项目启动

git clone git@github.com:electerm/electerm-sync-server-java.git
cd electerm-sync-server-java

# create env file, then edit .env
cp sample.env .env

## run
gradlew run

## build
gradlew build

# would show something like
# server running at http://127.0.0.1:7837

# in electerm sync settings, set custom sync server with:
# server url: http://127.0.0.1:7837
# JWT_SECRET: your JWT_SECRET in .env
# JWT_USER_NAME: one JWT_USER in .env

Test

gradlew test

Write your own data store

Just take src/main/java/ElectermSync/FileStore.java as an example, write your own read/write method

Sync server in other languages

• electerm-sync-server-kotlin
• electerm-sync-server-vercel
• electerm-sync-server-rust
• electerm-sync-server-cpp
• electerm-sync-server-java
• electerm-sync-server-node
• electerm-sync-server-python

License

MIT