Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
waybackarchiver committed Apr 23, 2023
1 parent abd215b commit d39398f
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 2 deletions.
25 changes: 24 additions & 1 deletion docs/integrations/xmpp.md
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
WIP
---
title: Interactive with XMPP
---

## How to build a XMPP Service

To create an XMPP account, you need to find a client and a public server. Here are some recommended collections of XMPP servers to help you get started.

- [Directory 404](https://xmpp.404.city/)
- [Public XMPP servers](https://list.jabber.at/)
- [Tracking the progress of OMEMO integration in XMPP clients](https://omemo.top)

## Configuration

To use the XMPP service, you will need to set the following environment variables or configuration file:

- `WAYBACK_IRC_JID`: The JID for the XMPP client (required).
- `WAYBACK_IRC_PASSWORD`: The password for the XMPP client (required).
- `WAYBACK_IRC_NOTLS`: Connect to XMPP server without TLS (optional).
- `WAYBACK_IRC_HELPTEXT`: The help text for XMPP command (optional).

## Further reading
- [XMPP | The universal messaging standard](https://xmpp.org/)

26 changes: 25 additions & 1 deletion docs/integrations/xmpp.zh.md
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
WIP
---
title: XMPP
---

## 如何构建XMPP服务

创建 XMPP 账户,您需要找到一个客户端和一个公共服务器。以下是一些推荐的 XMPP 服务器集合,可帮助您入门。

- [Directory 404](https://xmpp.404.city/)
- [Public XMPP servers](https://list.jabber.at/)
- [Tracking the progress of OMEMO integration in XMPP clients](https://omemo.top)

## 配置

为了使用XMPP服务,您需要设置以下环境变量或配置文件:

- `WAYBACK_IRC_JID`: XMPP客户端的JID(必填)。
- `WAYBACK_IRC_PASSWORD`: XMPP客户端的密码(必填)。
- `WAYBACK_IRC_NOTLS`: 连接到XMPP服务器时不使用TLS加密(可选)。
- `WAYBACK_IRC_HELPTEXT`: XMPP命令的帮助文本(可选)。

## 相关资料

- [XMPP | The universal messaging standard](https://xmpp.org/)

0 comments on commit d39398f

Please sign in to comment.