Update README.md

This commit is contained in:
Alexey
2026-01-07 19:06:28 +03:00
committed by GitHub
parent 1b7c09ae18
commit 384f927fc3

View File

@@ -33,23 +33,20 @@
- Extensive logging via `trace` and `debug` with `RUST_LOG` method - Extensive logging via `trace` and `debug` with `RUST_LOG` method
## Quick Start Guide ## Quick Start Guide
**This software is designed for Debian-based OS: in addition to Debian, these are Ubuntu, Mint, Kali, MX and many other Linux**
### Build 1. Download release
```bash ```bash
# Cloning repo wget https://github.com/telemt/telemt/releases/latest/download/telemt
git clone https://github.com/telemt/telemt
# Changing Directory to telemt
cd telemt
# Starting Release Build
cargo build --release
# Move to /bin
mv ./target/release/telemt /bin
# Make executable
chmod +x /bin/telemt
# Lets go!
telemt config.toml
``` ```
2. Move to Bin Folder
```bash
mv telemt /bin
```
4. Make Executable
```bash
chmod +x /bin/telemt
```
5. Go to [How to use?](#how-to-use) section for for further steps
## How to use? ## How to use?
### Telemt via Systemd ### Telemt via Systemd
**0. Check port and generate secrets** **0. Check port and generate secrets**
@@ -115,7 +112,7 @@ then Ctrl+X -> Y -> Enter to save
### Minimal Configuration for First Start ### Minimal Configuration for First Start
```toml ```toml
port = 443 # Listening port port = 443 # Listening port
show_links = ["tele", "hello"] show_links = ["tele", "hello"] # Specify users, for whom will be displayed the links
[users] [users]
tele = "00000000000000000000000000000000" # Replace the secret with one generated before tele = "00000000000000000000000000000000" # Replace the secret with one generated before
@@ -191,6 +188,23 @@ enabled = true
- in Russia on mobile networks, less in wired networks - in Russia on mobile networks, less in wired networks
- in Iran during "activity" - in Iran during "activity"
## Build
```bash
# Cloning repo
git clone https://github.com/telemt/telemt
# Changing Directory to telemt
cd telemt
# Starting Release Build
cargo build --release
# Move to /bin
mv ./target/release/telemt /bin
# Make executable
chmod +x /bin/telemt
# Lets go!
telemt config.toml
```
## Why Rust? ## Why Rust?
- Long-running reliability and idempotent behavior - Long-running reliability and idempotent behavior
- Rusts deterministic resource management - RAII - Rusts deterministic resource management - RAII