mirror of
https://github.com/chatmail/core.git
synced 2026-09-22 04:58:47 +03:00
f09f8fd8a4
Otherwise the lockfile is completely ignored as <https://doc.rust-lang.org/cargo/commands/cargo-install.html#dealing-with-the-lockfile> says "By default, the Cargo.lock file that is included with the package will be ignored." Mostly a reaction to <https://blog.rust-lang.org/2026/08/20/supply-chain-attack-on-arrayref/>
38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
# Delta Chat RPC server
|
|
|
|
This program provides a [JSON-RPC 2.0](https://www.jsonrpc.org/specification) interface to DeltaChat
|
|
over standard I/O.
|
|
|
|
## Install
|
|
|
|
To download binary pre-builds check the [releases page](https://github.com/chatmail/core/releases).
|
|
Rename the downloaded binary to `deltachat-rpc-server` and add it to your `PATH`.
|
|
|
|
To install from source run:
|
|
|
|
```sh
|
|
cargo install --locked --git https://github.com/chatmail/core/ deltachat-rpc-server
|
|
```
|
|
|
|
The `deltachat-rpc-server` executable will be installed into `$HOME/.cargo/bin` that should be available
|
|
in your `PATH`.
|
|
|
|
## Usage
|
|
|
|
To use just run `deltachat-rpc-server` command. The accounts folder will be created in the current
|
|
working directory unless `DC_ACCOUNTS_PATH` is set:
|
|
|
|
```sh
|
|
export DC_ACCOUNTS_PATH=$HOME/delta/
|
|
deltachat-rpc-server
|
|
```
|
|
|
|
The common use case for this program is to create bindings to use Delta Chat core from programming
|
|
languages other than Rust, for example:
|
|
|
|
1. Python: https://pypi.org/project/deltachat-rpc-client/
|
|
2. Go: https://github.com/deltachat/deltachat-rpc-client-go/
|
|
|
|
Run `deltachat-rpc-server --version` to check the version of the server.
|
|
Run `deltachat-rpc-server --openrpc` to get [OpenRPC](https://open-rpc.org/) specification of the provided JSON-RPC API.
|