From 0a0fa1d7a031f24ee2fb84fe280a5702353ca440 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kevin=20Svita=C4=8D?= Date: Wed, 6 Mar 2024 19:51:18 +0100 Subject: [PATCH] remove API docs --- docs/en/api/authentication.md | 13 --- docs/en/api/index.md | 7 -- docs/en/legal/privacy-policy.md | 2 - docs/uk/api/authentication.md | 13 --- docs/uk/api/index.md | 6 -- docs/uk/legal/privacy-policy.md | 2 - docs/zh/API/index.md | 8 -- ...53\344\273\275\351\252\214\350\257\201.md" | 80 ------------------- ...20\347\247\201\346\224\277\347\255\226.md" | 2 - 9 files changed, 133 deletions(-) delete mode 100644 docs/en/api/authentication.md delete mode 100644 docs/en/api/index.md delete mode 100644 docs/uk/api/authentication.md delete mode 100644 docs/uk/api/index.md delete mode 100644 docs/zh/API/index.md delete mode 100644 "docs/zh/API/\350\272\253\344\273\275\351\252\214\350\257\201.md" diff --git a/docs/en/api/authentication.md b/docs/en/api/authentication.md deleted file mode 100644 index 96c75a2a..00000000 --- a/docs/en/api/authentication.md +++ /dev/null @@ -1,13 +0,0 @@ -# Authentication - -## Forgot password? - -FreeFlarum's login form expects the same password hash as is your forum admin account's password. -This means that if you forgot your password, you may reset it at your forum: - -1. Ensure that you are logged out (you can use incognito/private browsing); -2. Click on the "Log In" button at your Flarum forum; -3. Click on the "Forgot password?" link in the bottom of the modal; -4. Input your admin's E-mail address; -5. Follow the instructions that were sent to that E-mail address and reset your password; -6. You may now use this new password to log in to FreeFlarum. diff --git a/docs/en/api/index.md b/docs/en/api/index.md deleted file mode 100644 index 89a98942..00000000 --- a/docs/en/api/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# API - -Since [U1-2022](https://discuss.flarum.org/d/7585/3885), FreeFlarum now provides you an easy access to its API. - -[View API documentation (Swagger)](https://api.freeflarum.com) - -If you are looking for details about authentication, please read [this page](https://docs.freeflarum.com/api/authentication) diff --git a/docs/en/legal/privacy-policy.md b/docs/en/legal/privacy-policy.md index 5acd8181..9938a856 100644 --- a/docs/en/legal/privacy-policy.md +++ b/docs/en/legal/privacy-policy.md @@ -64,8 +64,6 @@ Access tokens are created after a successful login to FreeFlarum's website, and - **User agent:** The user agent of the browser that created the access token - **Has elevated permissions:** Whether the access token has elevated permissions or not. -You can learn more about access tokens and FreeFlarum's authentication system [here](https://docs.freeflarum.com/api/authentication). - ### Does FreeFlarum use cookies? Yes, for the purpose of storing access tokens, which are fetched by FreeFlarum's server to authenticate the user (read above). This cookie is marked as "HttpOnly" for security reasons, and therefore can't be accessed by JavaScript. diff --git a/docs/uk/api/authentication.md b/docs/uk/api/authentication.md deleted file mode 100644 index e0a90020..00000000 --- a/docs/uk/api/authentication.md +++ /dev/null @@ -1,13 +0,0 @@ -# Authentication - -## Забули пароль? - -Форма входу на FreeFlarum очікує той самий хеш-пароль, що і пароль вашого облікового запису адміністратора форуму. -Це означає, що якщо ви забули свій пароль, ви можете відновити його на форумі: - -1. Переконайтеся, що ви вийшли з системи (ви можете використовувати інкогніто/приватний перегляд); -2. Натисніть на кнопку "Увійти" на вашому форумі Flarum;4. Input your admin's E-mail address; -3. Натисніть на посилання "Забули пароль?" внизу модального вікна; -4. Введіть адресу електронної пошти вашого адміністратора; -5. Дотримуйтесь інструкцій, які були надіслані на цю електронну адресу, і скиньте пароль; -6. Тепер ви можете використовувати цей новий пароль для входу на FreeFlarum. diff --git a/docs/uk/api/index.md b/docs/uk/api/index.md deleted file mode 100644 index a5e79547..00000000 --- a/docs/uk/api/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# API - -Починаючи з [U1-2022](https://discuss.flarum.org/d/7585/3885), FreeFlarum надає вам легкий доступ до свого API. -[View API documentation (Swagger)](https://api.freeflarum.com) - -Якщо ви шукаєте детальну інформацію про автентифікацію, будь ласка, прочитайте [цю сторінку](https://docs.freeflarum.com/api/authentication) diff --git a/docs/uk/legal/privacy-policy.md b/docs/uk/legal/privacy-policy.md index 64c1a251..8ca6645e 100644 --- a/docs/uk/legal/privacy-policy.md +++ b/docs/uk/legal/privacy-policy.md @@ -63,8 +63,6 @@ FreeFlarum використовує вашу електронну адресу - **Закінчується в:** Дата і час, коли закінчується термін дії токена доступу, для постійної дійсності може бути порожнім; - **Агент користувача:** Агент користувача браузера, який створив токен доступу - **Має підвищені дозволи:** Чи має токен доступу підвищені дозволи чи ні. - -Ви можете дізнатися більше про токени доступу та систему автентифікації FreeFlarum [тут](https://docs.freeflarum.com/api/authentication). ### Чи використовує FreeFlarum файли cookie? diff --git a/docs/zh/API/index.md b/docs/zh/API/index.md deleted file mode 100644 index bae51f18..00000000 --- a/docs/zh/API/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# API - -自 [U1-2022](https://discuss.flarum.org/d/7585/3885) 以来，FreeFlarum 现在为您提供了对其 API 的轻松访问。 - -[查看 API 文档 (Swagger)](https://api.freeflarum.com) - -如果您正在寻找有关身份验证的详细信息，请阅读[此页面](/zh/API/身份验证) - diff --git "a/docs/zh/API/\350\272\253\344\273\275\351\252\214\350\257\201.md" "b/docs/zh/API/\350\272\253\344\273\275\351\252\214\350\257\201.md" deleted file mode 100644 index 9165f5aa..00000000 --- "a/docs/zh/API/\350\272\253\344\273\275\351\252\214\350\257\201.md" +++ /dev/null @@ -1,80 +0,0 @@ -# 身份验证 - -> 本指南包含有关通过 [FreeFlarum 的 API](https://api.freeflarum.com) 而不是 [Flarum](https://docs.flarum.org/rest-api/) 进行身份验证（登录到 FreeFlarum 设置）的详细信息 。 -> -> 如果您有需要，我们还准备了 [FreeFlarum Python 包](https://github.com/CWKevo/freeflarum.py)。 - -## 忘记密码？ - -FreeFlarum 的登录表单需要与您的论坛管理员帐户密码相同的密码哈希。 -这意味着如果您忘记了密码，您可以在您的论坛上重置它： - -1.确保您已注销（您可以使用隐身/隐私浏览）； -2. 在您的 Flarum 论坛点击“登录”按钮； -3. 点击底部的“Forgot password?”按钮； -4. 输入您的管理员邮箱； -5. 按照发送到该电子邮件地址的说明重新设置您的密码； -6. 之后，您可以使用这个新密码登录 FreeFlarum。 - -## 访问令牌 - -如果您访问了 [FreeFlarum 上的帐户设置](https://freeflarum.com/settings/account_settings)，您可能已经注意到我们列出了您的所有访问令牌。 - -每次成功登录您的 FreeFlarum 论坛帐户时都会创建访问令牌。 外部应用可以使用它们代表您的帐户执行操作（例如：下载您的论坛数据、链接您的域、修复您的论坛、获取您的论坛信息等）。 - -您可以使用您的访问令牌之一使用第三方迁移服务，他们可以获取您的论坛数据并为您迁移您的论坛。 或者，您可能只是想创建一个个人脚本以在某些条件下访问您的网站。 - -所有 API 路由都列在 [https://api.freeflarum.com/](https://api.freeflarum.com/) 上。 - -### 具有“高级权限”的访问令牌 - -只有当您通过主网站 ([https://freeflarum.com](https://freeflarum.com)) 登录 FreeFlarum 时，才会创建具有“高级权限”的访问令牌。在主页之外创建的任何登录/访问令牌都不会具有高级权限。 - -#### 访问令牌的权限表 - -| 操作 | 普通令牌 | 具有高级权限的令牌 | -| ----------------------------------- | -------- | ------------------ | -| 获取论坛信息（标签、电子邮件等...） | ✅ | ✅ | -| 获取 FoF 上传限制 | ✅ | ✅ | -| 修复论坛 | ✅ | ✅ | -| 链接自定义域 | ✅ | ✅ | -| 获取（可用）服务器日志 | ✅ | ✅ | -| 导出您的论坛数据（也可导出为 CSV） | ✅ | ✅ | -| 撤销其他访问令牌 | ❌ | ✅ | -| 删除您的论坛 | ❌ | ✅ | - -出于安全考虑，只有在您通过 FreeFlarum 主网站登录时，您才可以删除您的论坛并撤销其他访问令牌。 - -但是，如果您复制具有高级权限的令牌并在 FreeFlarum 之外使用它，它仍将具有高级权限。 -建议您通过普通令牌使用第三方服务。 - -### "Remember me" - -默认情况下，登录 FreeFlarum 时不会勾选“记住我”选项，因此您的访问令牌将在 1 小时后过期。 -我们建议对一次性的第三方服务（如果他们在 1 小时内完成任务）这样做，这样 1 小时后令牌就不再有效。 - -如果您勾选“记住我”框，则令牌将永远有效换句话说，除非删除 `access_token` cookie（例如：清除浏览历史记录后）否则您不会被注销。 - -### 创建新的访问令牌 - -您有 2种方式来创建访问令牌： - -1. 通过FreeFlarum官网登录创建 -2. 向 [https://api.freeflarum.com/authentication](https://api.freeflarum.com/#/Authentication/login_authentication_post) 发送 API 请求 - -如果您无法创建 API 请求或者您根本不是技术人员，但需要某些第三方服务的访问令牌，那么我们推荐使用第一种方法。 - -如果要在保持登录状态时这样做，请打开一个新的无痕窗口（隐私标签页）或通过不同的浏览器/设备访问 FreeFlarum。然后，在不勾选“Remember me”框的情况下登录，您将得到一个临时（1 小时）令牌，但具有 [高级权限](#access-tokens-with-elevated-permissions)。如果您不想要高级权限，那么您需要通过 [api.freeflarum.com](https://api.freeflarum.com) 进行身份验证或发起 API 请求。 - -第二种方法非常适合在没有高级权限的情况下获取令牌，并在 [API 文档](https://api.freeflarum.com/#/Authentication/login_authentication_post) 中进行了描述。 - -### 撤销访问令牌 - -同样，您有 2 个选项： - -1. 登录 FreeFlarum.com 并点击访问令牌左侧的垃圾桶图标将其撤销； -2. 使用具有高级权限的访问令牌并发送 API 请求。 - -请注意，更改论坛管理员的密码不会撤销现有的访问令牌（这是由于技术限制——FreeFlarum 的 Python 后端无法与 Flarum 的 PHP 后端通信）。 - -如果您由于安全原因更改密码（例如：未经授权使用您的令牌或密码泄露），您将需要手动撤销所有现有的访问令牌（请参阅上面的可用方法）。 diff --git "a/docs/zh/\346\263\225\345\276\213\344\277\241\346\201\257/\351\232\220\347\247\201\346\224\277\347\255\226.md" "b/docs/zh/\346\263\225\345\276\213\344\277\241\346\201\257/\351\232\220\347\247\201\346\224\277\347\255\226.md" index bac90404..d945542f 100644 --- "a/docs/zh/\346\263\225\345\276\213\344\277\241\346\201\257/\351\232\220\347\247\201\346\224\277\347\255\226.md" +++ "b/docs/zh/\346\263\225\345\276\213\344\277\241\346\201\257/\351\232\220\347\247\201\346\224\277\347\255\226.md" @@ -65,8 +65,6 @@ FreeFlarum的数据库存储以下记录： - **具有提升权限：**访问令牌是否具有提升权限。 -您可以了解更多关于访问令牌和FreeFlarum身份验证系统的信息[此处](https://docs.freeflarum.com/zh/API/身份验证/). - ### FreeFlarum使用Cookie吗？ 是的，用于存储访问令牌，这些令牌由FreeFlarum的服务器获取以验证用户身份（如上所述）。出于安全原因，此cookie被标记为“HttpOnly”，因此JavaScript无法访问。 其他Cookie可能来自第三方服务，不会受到FreeFlarum的影响（请阅读下文）。FreeFlarum管理的Cookie仅用于维护其正常功能，过去/现在/将来不会用于营销目的。