README

AtomTerm 是一个 telnet 服务器，当通过 telnet 客户端访问时，会将目录作为可导航菜单部署，类似于 BBS。

用法

服务器

给定一个根目录，AtomTerm 解析该目录并创建一个包含菜单和文档的“网页”，例如，此存储库中 menu/ 文件夹下的示例目录看起来如下

menu/
├─ submenu/
│  ├─ empty.txt
│  ├─ laika.txt
│  ├─ nested_document.txt
│  ├─ meta.json
├─ meta.json
├─ document.txt

每个文件夹都是一个菜单，包含其下的菜单和文档的链接，同时每个 *.txt 文件都是一个文档，其第一行是其标题。

meta.json 文件包含有关特定菜单的信息，即 title 和 description。

根目录、主机和根由 config.json 确定，其示例可在此存储库中查看。

### 客户端

任何 telnet 客户端都应该能够连接到由 AtomTerm 运行的服务器，具体取决于它是否有 NAWS 支持，AtomTerm 也会填充终端屏幕。

安装

### 使用 Composer

您可以使用 composer 需要此软件包

composer require ambertide/atomterm

完成此操作后，serve.php 将被添加到您的 vendor/bin 目录（或您放置供应商二进制的任何位置），并且您可以执行它

php vendor/bin/serve.php

这将启动服务器。

使用 Docker

您也可以使用包含的 Dockerfile 运行此软件包，但是，此软件包的 Docker 版本将在 Docker 主机的 "/static" 目录下查找您的文件，因此您需要在 /static 下包含一个挂载点。

本地

最后，您还可以本地安装此存储库本身。尽管 Atomterm 没有外部依赖项，但它确实需要一个启用了 sockets 扩展的 PHP 安装，版本在 8.3 以上。

git clone https://github.com/ambertide/AtomTerm.git`
cd AtomTerm
composer install
composer dump-autoload
mv config.json.default config.json
composer run serve -- config.json

ambertide / atomterm

维护者

详细信息

README

用法

服务器

安装

使用 Docker

本地