docs: repo move (wip)
This commit is contained in:
naskya
parent
ddde16cfdf
commit
08232ae946
11 changed files with 30 additions and 37 deletions
31
README.md
31
README.md
|
|
@ -1,9 +1,7 @@
|
|||
<div align="center">
|
||||
<a href="https://joinfirefish.org/">
|
||||
<img src="./title.svg" alt="Firefish logo" style="border-radius:50%" width="400"/>
|
||||
</a>
|
||||
<img src="./title.svg" alt="Firefish logo" style="border-radius:50%" width="400"/>
|
||||
|
||||
**🌎 **[Firefish](https://joinfirefish.org/)** is an open source, decentralized social media platform that's free forever! 🚀**
|
||||
**🌎 Firefish is an open source, decentralized social media platform that's free forever! 🚀**
|
||||
|
||||
[](https://nogithub.codeberg.page/)
|
||||
<!-- [](https://ci.codeberg.org/firefish/firefish) -->
|
||||
|
|
@ -54,44 +52,31 @@
|
|||
- If you have the means to, [donations](https://opencollective.com/Firefish) are a great way to keep us going.
|
||||
- If you know how to program in TypeScript, Vue, or Rust, read the [contributing](./CONTRIBUTING.md) document.
|
||||
- If you know a non-English language, translating Firefish on [Weblate](https://hosted.weblate.org/engage/firefish/) help bring Firefish to more people. No technical experience needed!
|
||||
- Want to write/report about us, have any professional inquiries, or just have questions to ask? Contact us [here!](https://joinfirefish.org/contact/)
|
||||
|
||||
### All links
|
||||
|
||||
- 🌐 Homepage: <https://joinfirefish.org>
|
||||
- 💸 Donations:
|
||||
- OpenCollective: <https://opencollective.com/Firefish>
|
||||
- Liberapay: <https://liberapay.com/ThatOneCalculator>
|
||||
- Donate publicly to get your name on the Patron list!
|
||||
- 🚢 Flagship server: <https://firefish.social>
|
||||
- 💁 Matrix support room: <https://matrix.to/#/#firefish:matrix.fedibird.com>
|
||||
- 📣 Official account: <a href="https://fedi.software/@firefish" rel="me">@firefish</a>
|
||||
- 📜 Server list: <https://joinfirefish.org/join>
|
||||
- 📣 Official account: <a href="https://info.firefish.dev/@firefish" rel="me">`@firefish@info.firefish.dev`</a>
|
||||
- ✍️ Weblate: <https://hosted.weblate.org/engage/firefish/>
|
||||
- ️️📬 Contact: <https://joinfirefish.org/contact/>
|
||||
|
||||
# 🌠 Getting started
|
||||
|
||||
Want to just join a Firefish server? View the list here, pick one, and join:
|
||||
|
||||
### https://joinfirefish.org/join
|
||||
|
||||
---
|
||||
|
||||
Want to make your own? Keep reading!
|
||||
|
||||
This guide will work for both **starting from scratch** and **migrating from Misskey**.
|
||||
|
||||
## 🔰 Easy installers
|
||||
|
||||
If you have access to a server that supports one of the sources below, I recommend you use it! Note that these methods *won't* allow you to migrate from Misskey without manual intervention.
|
||||
|
||||
[](https://git.joinfirefish.org/firefish/ubuntu-bash-install) [](https://aur.archlinux.org/packages/firefish) [](https://install-app.yunohost.org/?app=firefish)
|
||||
[](https://firefish.dev/firefish/ubuntu-bash-install) [](https://aur.archlinux.org/packages/firefish) [](https://install-app.yunohost.org/?app=firefish)
|
||||
|
||||
## 🛳️ Containerization
|
||||
|
||||
- [🐳 How to run Firefish with Docker](https://git.joinfirefish.org/firefish/firefish/-/blob/develop/docs/docker.md)
|
||||
- [🛞 How to run Firefish with Kubernetes/Helm](https://git.joinfirefish.org/firefish/firefish/-/blob/develop/docs/kubernetes.md)
|
||||
- [🐳 How to run Firefish with Docker](https://firefish.dev/firefish/firefish/-/blob/develop/docs/docker.md)
|
||||
- [🛞 How to run Firefish with Kubernetes/Helm](https://firefish.dev/firefish/firefish/-/blob/develop/docs/kubernetes.md)
|
||||
|
||||
## 🧑💻 Dependencies
|
||||
|
||||
|
|
@ -127,7 +112,7 @@ If you have access to a server that supports one of the sources below, I recomme
|
|||
## 👀 Get folder ready
|
||||
|
||||
```sh
|
||||
git clone https://git.joinfirefish.org/firefish/firefish.git
|
||||
git clone https://firefish.dev/firefish/firefish.git
|
||||
cd firefish/
|
||||
```
|
||||
|
||||
|
|
@ -219,7 +204,7 @@ Please don't use ElasticSearch unless you already have an ElasticSearch setup an
|
|||
|
||||
## 🚚 Migrating from Misskey/FoundKey to Firefish
|
||||
|
||||
For migrating from Misskey v13, Misskey v12, and FoundKey, read [this document](https://git.joinfirefish.org/firefish/firefish/-/blob/develop/docs/migrate.md).
|
||||
For migrating from Misskey v13, Misskey v12, and FoundKey, read [this document](https://firefish.dev/firefish/firefish/-/blob/develop/docs/migrate.md).
|
||||
|
||||
## 🌐 Web proxy
|
||||
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ A fun, new, open way to experience social media https://joinfirefish.org
|
|||
| elasticsearch | object | `{"auth":{},"enabled":false,"hostname":"","port":9200,"ssl":false}` | https://github.com/bitnami/charts/tree/master/bitnami/elasticsearch#parameters |
|
||||
| fullnameOverride | string | `""` | |
|
||||
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||
| image.repository | string | `"registry.joinfirefish.org/firefish/firefish"` | |
|
||||
| image.repository | string | `"registry.firefish.dev/firefish/firefish"` | |
|
||||
| image.tag | string | `""` | |
|
||||
| imagePullSecrets | list | `[]` | |
|
||||
| ingress.annotations | object | `{}` | |
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
replicaCount: 1
|
||||
|
||||
image:
|
||||
repository: registry.joinfirefish.org/firefish/firefish
|
||||
repository: registry.firefish.dev/firefish/firefish
|
||||
pullPolicy: IfNotPresent
|
||||
# Overrides the image tag whose default is the chart appVersion.
|
||||
tag: ""
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ version: "3"
|
|||
|
||||
services:
|
||||
web:
|
||||
image: registry.joinfirefish.org/firefish/firefish
|
||||
image: registry.firefish.dev/firefish/firefish
|
||||
build: ..
|
||||
container_name: firefish_web
|
||||
restart: always
|
||||
|
|
|
|||
|
|
@ -2,9 +2,7 @@ version: "3"
|
|||
|
||||
services:
|
||||
web:
|
||||
# Choose one of these tags:
|
||||
# stable-amd64, stable-arm64, beta-amd64, beta-arm64
|
||||
image: registry.joinfirefish.org/firefish/firefish:stable-amd64
|
||||
image: registry.firefish.dev/firefish/firefish:latest
|
||||
container_name: firefish_web
|
||||
restart: unless-stopped
|
||||
depends_on:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# 🐳 Running a Firefish server with Docker
|
||||
|
||||
## Pre-built docker container
|
||||
[registry.joinfirefish.org/firefish/firefish](https://git.joinfirefish.org/firefish/firefish/container_registry)
|
||||
[registry.firefish.dev/firefish/firefish](https://firefish.dev/firefish/firefish/container_registry)
|
||||
|
||||
## `docker-compose`
|
||||
|
||||
|
|
@ -29,7 +29,7 @@ Everything else can be left as-is.
|
|||
|
||||
## Running docker-compose
|
||||
|
||||
The [prebuilt container for firefish](https://git.joinfirefish.org/firefish/firefish/container_registry) is fairly large, and may take a few minutes to download and extract using docker.
|
||||
The [prebuilt container for firefish](https://firefish.dev/firefish/firefish/container_registry) is fairly large, and may take a few minutes to download and extract using docker.
|
||||
|
||||
Copy `docker-compose.yml` and the `config/` to a directory, then run the **docker-compose** command:
|
||||
`docker-compose up -d`.
|
||||
|
|
|
|||
10
docs/notice-for-admins.md
Normal file
10
docs/notice-for-admins.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
## For all users
|
||||
|
||||
- The git repository has been moved, so please update the `git remote` url.
|
||||
```sh
|
||||
git remote set-url origin https://firefish.dev/firefish/firefish.git
|
||||
```
|
||||
|
||||
## For Docker/Podman users
|
||||
|
||||
- The image tag has been changed to `registry.firefish.dev/firefish/firefish:latest`, so please update `docker-compose.yml`.
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
"codename": "aqua",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://git.joinfirefish.org/firefish/firefish.git"
|
||||
"url": "https://firefish.dev/firefish/firefish.git"
|
||||
},
|
||||
"packageManager": "pnpm@8.13.1",
|
||||
"private": true,
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@
|
|||
<FormSection>
|
||||
<div class="_formLinks">
|
||||
<FormLink
|
||||
to="https://git.joinfirefish.org/firefish/firefish"
|
||||
to="https://firefish.dev/firefish/firefish"
|
||||
external
|
||||
>
|
||||
<template #icon
|
||||
|
|
@ -153,7 +153,7 @@
|
|||
</div>
|
||||
<h3>
|
||||
<MkLink
|
||||
url="https://git.joinfirefish.org/firefish/firefish/activity"
|
||||
url="https://firefish.dev/firefish/firefish/activity"
|
||||
>{{ i18n.ts._aboutFirefish.allContributors }}
|
||||
</MkLink>
|
||||
</h3>
|
||||
|
|
|
|||
|
|
@ -456,7 +456,7 @@ defineProps<{
|
|||
|
||||
const preview_mention = ref("@example");
|
||||
const preview_hashtag = ref("#test");
|
||||
const preview_link = ref(`[${i18n.ts._mfm.dummy}](https://joinfirefish.org)`);
|
||||
const preview_link = ref(`[${i18n.ts._mfm.dummy}](https://firefish.dev)`);
|
||||
const preview_emoji = ref(
|
||||
instance.emojis.length ? `:${instance.emojis[0].name}:` : ":emojiname:",
|
||||
);
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
"name": "firefish-js",
|
||||
"version": "0.0.27",
|
||||
"description": "Firefish SDK for JavaScript",
|
||||
"homepage": "https://git.joinfirefish.org/firefish/firefish/-/tree/develop/packages/firefish-js",
|
||||
"homepage": "https://firefish.dev/firefish/firefish/-/tree/develop/packages/firefish-js",
|
||||
"main": "./built/index.js",
|
||||
"types": "./built/index.d.ts",
|
||||
"license": "MIT",
|
||||
|
|
@ -17,7 +17,7 @@
|
|||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://git.joinfirefish.org/firefish/firefish.git"
|
||||
"url": "https://firefish.dev/firefish/firefish.git"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@swc/cli": "^0.1.63",
|
||||
|
|
|
|||
Loading…
Reference in a new issue