Skip to content

Commit 8df53c9

Browse files
author
Sudo-Ivan
committed
update: v0.1.1
1 parent 6b58354 commit 8df53c9

File tree

10 files changed

+779
-574
lines changed

10 files changed

+779
-574
lines changed

README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# LXMFy JS8Call Bot
2+
3+
LXMF JS8Call bot that uses the [LXMFy bot framework](https://lxmfy.github.io/LXMFy/).
4+
5+
## Installation
6+
7+
**Docker:**
8+
9+
```bash
10+
docker run -d \
11+
--name lxmfy-js8call-bot \
12+
--network host \
13+
-v $(pwd)/testbot/config:/bot/config \
14+
-v $(pwd)/testbot/.reticulum:/root/.reticulum \
15+
-v $(pwd)/testbot/storage:/bot/storage \
16+
--restart unless-stopped \
17+
ghcr.io/lxmfy/lxmfy-js8call-bot:latest
18+
```
19+
20+
**Podman:**
21+
22+
```bash
23+
podman run -d \
24+
--name lxmfy-js8call-bot \
25+
--network host \
26+
-v $(pwd)/testbot/config:/bot/config \
27+
-v $(pwd)/testbot/.reticulum:/root/.reticulum \
28+
-v $(pwd)/testbot/storage:/bot/storage \
29+
--restart unless-stopped \
30+
ghcr.io/lxmfy/lxmfy-js8call-bot:latest
31+
```
32+
33+
**Manual:**
34+
35+
```bash
36+
poetry install
37+
poetry run lxmfy-js8call-bot
38+
```
39+
40+
## Configuration
41+
42+
The bot uses a configuration file located at `config/lxmfy_js8call_bot.ini`. You can use example-config.ini as a template.
43+
44+
## Development
45+
46+
```bash
47+
poetry install
48+
poetry run lxmfy-js8call-bot
49+
```
50+
51+
## Docker
52+
53+
```bash
54+
docker build -t lxmfy-js8call-bot .
55+
56+
57+
docker run -d \
58+
--name lxmfy-js8call-bot \
59+
--network host \
60+
-v $(pwd)/testbot/config:/bot/config \
61+
-v $(pwd)/testbot/.reticulum:/root/.reticulum \
62+
-v $(pwd)/testbot/storage:/bot/storage \
63+
--restart unless-stopped \
64+
lxmfy-js8call-bot
65+
```
66+
67+
## Podman
68+
69+
```bash
70+
podman run -d \
71+
--name lxmfy-js8call-bot \
72+
--network host \
73+
-v $(pwd)/testbot/config:/bot/config \
74+
-v $(pwd)/testbot/.reticulum:/root/.reticulum \
75+
-v $(pwd)/testbot/storage:/bot/storage \
76+
--restart unless-stopped \
77+
lxmfy-js8call-bot
78+
```

0 commit comments

Comments
 (0)