Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ADDITIONAL_TERMS.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you convey (distribute) the software or any modified version of it, or operat

1. The name of the original software: **OpenMiQ**
2. The name of the original author: **otoneko.**
3. The URL of the original repository: **https://github.com/otnc/OpenMiQ**
3. The URL of the original repository: **https://github.com/OpenMiQ/discord-bot**

The attribution must be provided:

Expand All @@ -22,7 +22,7 @@ The attribution must be provided:

## 2. Marking of Modified Versions (Section 7(c))

You must not represent a modified version of the software as the original. If you convey or operate a modified version, you must mark it in a reasonable way as modified, for example by stating that it is "based on OpenMiQ (https://github.com/otnc/OpenMiQ), with modifications", and by identifying yourself or the modified version under a name that is not identical to "OpenMiQ".
You must not represent a modified version of the software as the original. If you convey or operate a modified version, you must mark it in a reasonable way as modified, for example by stating that it is "based on OpenMiQ (https://github.com/OpenMiQ/discord-bot), with modifications", and by identifying yourself or the modified version under a name that is not identical to "OpenMiQ".

## 3. No Trademark License

Expand Down
12 changes: 6 additions & 6 deletions README-ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

_[English](./README.md)_

メッセージをクォート画像に変換する、セルフホスト型の**Web API**です。Discord Bot版の[OpenMiQ](https://github.com/otnc/OpenMiQ)をもとに、Web API向けに改変しています — 詳細は[Credits](#credits)を参照してください。
メッセージをクォート画像に変換する、セルフホスト型の**Web API**です。Discord Bot版の[OpenMiQ](https://github.com/OpenMiQ/discord-bot)をもとに、Web API向けに改変しています — 詳細は[Credits](#credits)を参照してください。

## Discord Bot版との違い

Expand All @@ -33,8 +33,8 @@ _[English](./README.md)_
### クイックスタート

```bash
git clone https://github.com/otnc/OpenMiQ-API.git
cd OpenMiQ-API
git clone https://github.com/OpenMiQ/api.git
cd api
pnpm install
cp .env.example .env # 値を埋める。詳細は下記Configurationを参照
pnpm run db:migrate # SQLiteスキーマを適用
Expand Down Expand Up @@ -133,8 +133,8 @@ otoneko. https://github.com/otnc

## Credits

- **OpenMiQ** — https://github.com/otnc/OpenMiQ — 本APIはDiscord Bot「OpenMiQ」(**otoneko.**作)をもとに、Web APIとして公開するための改変を加えたものです。
- **makeitaquote** — https://github.com/otnc/makeitaquote — 本APIが画像生成に使用しているライブラリです。
- **OpenMiQ** — https://github.com/OpenMiQ/discord-bot — 本APIはDiscord Bot「OpenMiQ」(**otoneko.**作)をもとに、Web APIとして公開するための改変を加えたものです。
- **makeitaquote** — https://github.com/OpenMiQ/makeitaquote — 本APIが画像生成に使用しているライブラリです。
- Make it a Quote (Twitter) — https://twitter.com/MakeItAQuote
- Make it a Quote (Discord/Misskey/Bluesky) — https://miq.moe/
- アイコン・ロゴ: 原作者(OpenMiQの著作者でもあります)の許諾のもと使用しています — 詳細は[ADDITIONAL_TERMS.md](./ADDITIONAL_TERMS.md#4-brand-assets-githubassets)を参照してください。
Expand All @@ -144,7 +144,7 @@ otoneko. https://github.com/otnc
本プロジェクトは[GNU Affero General Public License v3.0 or later](./LICENSE)のもとでライセンスされており、OpenMiQ本家が付している[追加条項](./ADDITIONAL_TERMS.md)(AGPL-3.0 第7条)をそのまま引き継いでいます — 本APIはOpenMiQの改変版であるため、これらの条項は無改変のまま維持されます。

- **SPDX:** `AGPL-3.0-or-later`(AGPL-3.0 第7条に基づく追加条項付き)
- 本APIの改変版を配布または運用する場合、同じ追加条項により、改変版のソースをAGPL-3.0のもとで公開し、OpenMiQ(本家リポジトリURL: https://github.com/otnc/OpenMiQ)への帰属表示を[ADDITIONAL_TERMS.md](./ADDITIONAL_TERMS.md)に記載の方法で行う必要があります。
- 本APIの改変版を配布または運用する場合、同じ追加条項により、改変版のソースをAGPL-3.0のもとで公開し、OpenMiQ(本家リポジトリURL: https://github.com/OpenMiQ/discord-bot) への帰属表示を[ADDITIONAL_TERMS.md](./ADDITIONAL_TERMS.md)に記載の方法で行う必要があります。

## クライアントライブラリ

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

_[日本語](./README-ja.md)_

A self-hosted **Web API** that turns a message into a quote image over HTTP. Based on [OpenMiQ](https://github.com/otnc/OpenMiQ) (a Discord bot), with modifications for a Web API — see [Credits](#credits).
A self-hosted **Web API** that turns a message into a quote image over HTTP. Based on [OpenMiQ](https://github.com/OpenMiQ/discord-bot) (a Discord bot), with modifications for a Web API — see [Credits](#credits).

## What's different from the Discord bot version

Expand All @@ -33,8 +33,8 @@ A self-hosted **Web API** that turns a message into a quote image over HTTP. Bas
### Quick start

```bash
git clone https://github.com/otnc/OpenMiQ-API.git
cd OpenMiQ-API
git clone https://github.com/OpenMiQ/api.git
cd api
pnpm install
cp .env.example .env # fill in the values, see Configuration below
pnpm run db:migrate # applies the SQLite schema
Expand Down Expand Up @@ -133,8 +133,8 @@ otoneko. https://github.com/otnc

## Credits

- **OpenMiQ** — https://github.com/otnc/OpenMiQ — this API is based on OpenMiQ (a Discord bot) by **otoneko.**, with modifications to expose it as a Web API.
- **makeitaquote** — https://github.com/otnc/makeitaquote — the library this API renders images with.
- **OpenMiQ** — https://github.com/OpenMiQ/discord-bot — this API is based on OpenMiQ (a Discord bot) by **otoneko.**, with modifications to expose it as a Web API.
- **makeitaquote** — https://github.com/OpenMiQ/makeitaquote — the library this API renders images with.
- Make it a Quote (Twitter) — https://twitter.com/MakeItAQuote
- Make it a Quote (Discord/Misskey/Bluesky) — https://miq.moe/
- Icon/Logo: used with permission of their original author (also the author of OpenMiQ) — see [ADDITIONAL_TERMS.md](./ADDITIONAL_TERMS.md#4-brand-assets-githubassets).
Expand All @@ -144,7 +144,7 @@ otoneko. https://github.com/otnc
This project is licensed under the [GNU Affero General Public License v3.0 or later](./LICENSE), carrying forward the [additional terms](./ADDITIONAL_TERMS.md) OpenMiQ itself is licensed under (AGPL-3.0 Section 7) — preserved here, unmodified, since this API is a modified version of that software.

- **SPDX:** `AGPL-3.0-or-later` (with additional terms under AGPL-3.0 Section 7)
- If you distribute or run a modified version of _this_ API, the same additional terms require you to make your modified source available under AGPL-3.0 and to display attribution to OpenMiQ (original repository URL: https://github.com/otnc/OpenMiQ) as described in [ADDITIONAL_TERMS.md](./ADDITIONAL_TERMS.md).
- If you distribute or run a modified version of _this_ API, the same additional terms require you to make your modified source available under AGPL-3.0 and to display attribution to OpenMiQ (original repository URL: https://github.com/OpenMiQ/discord-bot) as described in [ADDITIONAL_TERMS.md](./ADDITIONAL_TERMS.md).

## Client library

Expand Down
11 changes: 11 additions & 0 deletions apps/api/legal/terms/3/TERMS-ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# 利用規約

OpenMiQ-APIは、OpenMiQ (https://github.com/OpenMiQ/discord-bot) をもとにしたセルフホスト型のクォート画像生成APIであり、GNU Affero General Public License v3.0 or laterおよびADDITIONAL_TERMS.mdに記載の追加条項のもとで提供されます。

APIキーは、Discordアカウントを連携し管理者の承認を得た場合にのみ発行されます。APIキーを第三者と共有すること、不正利用・スパム・違法な目的での利用は禁止します。本規約への違反はAPIキーの即時取消およびBANの対象となります。

各APIキーにはレート制限が適用され、現在の利用状況はAPI Consoleまたは GET /api/usage からいつでも確認できます。

本サービスはセルフホストで運用されており、稼働時間の保証(SLA)はありません。「hosted: true」で生成された画像はサーバー上に一時的に保存されるものであり、恒久的な保存を保証するホスティングサービスではありません。詳細はプライバシーポリシーを参照してください。

本規約は今後変更されることがあります。現在のバージョンはTERMS_VERSIONで管理され、重要な変更があった場合は再同意をお願いします。
11 changes: 11 additions & 0 deletions apps/api/legal/terms/3/TERMS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Terms of Service

OpenMiQ-API is a self-hosted quote-image generation API, based on OpenMiQ (https://github.com/OpenMiQ/discord-bot) and licensed under the GNU Affero General Public License v3.0 or later, with the additional terms in ADDITIONAL_TERMS.md.

An API key is only issued after linking your Discord account and being approved by an administrator. You must not share your API key with others, and you must not use the service for abuse, spam, or any illegal purpose. Violating these terms may result in immediate API key revocation and a ban.

Each API key is subject to a rate limit, and its current usage can be checked at any time via the API Console or GET /api/usage.

This service is self-hosted and run without any uptime guarantee (no SLA). Images generated with "hosted: true" are stored on the server temporarily and are not a guaranteed permanent hosting service — see the Privacy Policy.

These terms may change over time; the current version is tracked by TERMS_VERSION, and you will be asked to re-agree after a meaningful change.
2 changes: 1 addition & 1 deletion apps/api/src/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export function createApp(env: Env) {
title: "OpenMiQ-API",
version: "0.1.0",
description:
"Based on OpenMiQ (https://github.com/otnc/OpenMiQ) by otoneko., with modifications for a Web API. Source: https://github.com/otnc/OpenMiQ-API",
"Based on OpenMiQ (https://github.com/OpenMiQ/discord-bot) by otoneko., with modifications for a Web API. Source: https://github.com/OpenMiQ/api",
},
});
app.get("/api/docs", swaggerUI({ url: "/api/docs/openapi.json" }));
Expand Down
4 changes: 2 additions & 2 deletions apps/api/src/routes/about.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ export function createAboutApp(env: Env) {
basedOn: {
name: "OpenMiQ",
author: "otoneko.",
url: "https://github.com/otnc/OpenMiQ",
url: "https://github.com/OpenMiQ/discord-bot",
},
sourceUrl: "https://github.com/otnc/OpenMiQ-API",
sourceUrl: "https://github.com/OpenMiQ/api",
discordInviteUrl: env.DISCORD_INVITE_URL ?? null,
playgroundSharedKeyAvailable: env.PLAYGROUND_SHARED_KEY_LIMIT > 0,
});
Expand Down
2 changes: 1 addition & 1 deletion apps/web/src/routes/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
class="hover:text-foreground">{tr.common.apiDocs}</a
>
<a
href="https://github.com/otnc/OpenMiQ-API"
href="https://github.com/OpenMiQ/api"
target="_blank"
rel="noopener noreferrer"
class="hover:text-foreground">{tr.footer.sourceCode}</a
Expand Down
8 changes: 4 additions & 4 deletions apps/web/src/routes/+page.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
class="text-primary font-medium underline">npm</a
>
<a
href="https://github.com/otnc/OpenMiQ-API/tree/main/packages/openmiq"
href="https://github.com/OpenMiQ/api/tree/main/packages/openmiq"
target="_blank"
rel="noopener noreferrer"
class="text-primary font-medium underline">GitHub</a
Expand Down Expand Up @@ -103,15 +103,15 @@
<Card.Content class="text-muted-foreground space-y-2 text-sm">
<p>
<a
href="https://github.com/otnc/OpenMiQ-API"
href="https://github.com/OpenMiQ/api"
target="_blank"
rel="noopener noreferrer"
class="hover:text-foreground underline">OpenMiQ-API</a
> — this Web API, and the source you're looking at right now.
</p>
<p>
<a
href="https://github.com/otnc/OpenMiQ"
href="https://github.com/OpenMiQ/discord-bot"
target="_blank"
rel="noopener noreferrer"
class="hover:text-foreground underline">OpenMiQ</a
Expand All @@ -121,7 +121,7 @@
</p>
<p>
<a
href="https://github.com/otnc/makeitaquote"
href="https://github.com/OpenMiQ/makeitaquote"
target="_blank"
rel="noopener noreferrer"
class="hover:text-foreground underline">makeitaquote</a
Expand Down
4 changes: 2 additions & 2 deletions docs/DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
## 1. リポジトリの取得・依存関係のインストール・DB準備

```bash
git clone https://github.com/otnc/OpenMiQ-API.git
cd OpenMiQ-API
git clone https://github.com/OpenMiQ/api.git
cd api
pnpm install
cp .env.example .env # このあと値を埋める(§2参照)
pnpm run db:migrate
Expand Down
Loading
Loading