Commit Graph

218 Commits

Author SHA1 Message Date
Norm cb2d0fdd9e docs: fix systemctl edit command in install guide 2023-05-30 02:30:39 +00:00
Norm 56e2000306 docs: use correct capitalization for directory in example service files
This should hopefully cut down on any confusion during the install process.
2023-05-30 01:36:56 +00:00
Johann150 4a77e93dfd
document environment variables 2023-05-23 19:51:55 +02:00
Norm 6886ddb689
docs: reformat warnings and update Misskey references in emoji docs 2023-05-20 23:18:58 +02:00
Norm eafacbba99 docs: fix typo in migration revert script 2023-05-20 06:41:39 -04:00
Norm 95ecdeabff
docs: Add note about SELinux volume mount option in Docker guide
Something that I've discovered while trying to run FoundKey's
docker-compose config on Podman via podman-compose on my Fedora laptop.
2023-04-12 00:35:34 -04:00
Norm 24db102679 Merge pull request 'docs: Add Docker install guide' (#348) from docs/docker into main
Reviewed-on: FoundKeyGang/FoundKey#348
2023-04-01 14:22:43 +00:00
Norm 9b7dcb4262
Update instructions to match changes in da246ce419 2023-03-25 01:42:33 -04:00
Norm da246ce419 docs: Update install guide to use tag-merge strategy (#117)
Adapted from @toast 's guide: https://mk.toast.cafe/notes/93o9n4tfsi

Reviewed-on: FoundKeyGang/FoundKey#117
2023-03-23 16:34:01 +00:00
Norm 5662635d45 Update branch checked out to "main" 2023-03-22 18:39:04 -04:00
Norm 5ffcb9f235 remove docker-compose.yml.example command 2023-03-22 18:39:04 -04:00
Norm b046718d1d Use `docker compose down` instead of `stop` 2023-03-22 18:39:04 -04:00
Norm ecbe984315 Add suggestions from @EpicKitty 2023-03-22 18:39:04 -04:00
Norm 139ccd2580 docs: Add Docker install guide
Based on Misskey's Docker guide:
https://github.com/misskey-dev/misskey-hub/blob/main/src/en/docs/install/docker.md
2023-03-22 18:39:04 -04:00
Johann150 691c9d4972
fix typo 2023-03-03 23:47:31 +01:00
Johann150 ae1e7883e7
improve docs files 2023-03-03 23:46:45 +01:00
Johann150 96e6187e83
docs: admin password reset 2023-01-14 12:03:50 +01:00
Norm 83373e0c51
split build task into parallel and non-parallel versions
This allows FoundKey to be built on systems with 2GB or less RAM without swapping or running out of memory.
2023-01-12 17:08:50 -05:00
Johann150 11518d2f26
add documentation about moderation 2023-01-12 20:53:39 +01:00
Norm cf7449509f docs: add rfc links to oauth documentation 2022-12-10 05:23:22 +00:00
Johann150 7924d5d01b add oauth documentation 2022-12-03 10:38:33 +00:00
Norm b030ced51c
docs: Replace references of misskey with foundkey in nginx guide 2022-12-01 04:50:30 -05:00
Norm 97288cb75f docs: Make IRC stuff a proper subsection in install/migration guides 2022-12-01 00:32:24 -05:00
Norm 9c22d904bf docs: Add IRC contact to migration guide
Makes it consistent with the install guide and helps users reach the appropriate place to get support.
2022-12-01 00:59:40 +00:00
SuperDicq 2edb41adb1 docs: Update migration guide with additional info (#257)
Reviewed-on: FoundKeyGang/FoundKey#257
Co-authored-by: SuperDicq <info@jiyu.dev>
Co-committed-by: SuperDicq <info@jiyu.dev>
2022-12-01 00:41:56 +00:00
Norm 3deec7d30a
docs: make yarn required in install guide
Since the move to Yarn workspaces in
10caf861e8, the package.json scripts rely
on Yarn being available to function properly due to the use of
workspaces.

Because of this, Yarn has basically been required to be able to properly
set up and run FoundKey. Using `npx yarn` probably won't work anymore
with modern yarn versions.
2022-11-19 23:22:11 -05:00
Johann150 41a710854e
docs: update install guide to node 18
Node.js 18 is not technically required yet but it makes sense to
already recommend the newer version for new installs.

Ref: FoundKeyGang/FoundKey#238
2022-11-18 20:59:14 +01:00
Norm e79d7879c6 docs/migrating: Make yarn instructions version-agnostic
This means we don't have to update the yarn version here in case we update the version of Yarn used.
2022-11-02 22:58:02 +00:00
Norm ba911dab65 Update 'docs/migrating.md' 2022-10-22 17:49:50 +00:00
Norm 058d414fff docs: add migration guide
Includes tag-merge workflow from @toast 's post at
https://mk.toast.cafe/notes/93o9n4tfsi
2022-09-08 05:09:15 +00:00
Norm 2e94ea3adc
docs/install: Move user creation after installing deps 2022-08-25 14:10:19 -04:00
Norm 617f064d61
Update 'docs/INSTALL.md'
Fix some styling stuff.
2022-08-25 14:10:19 -04:00
Norm 9198ccb400
Use more neutral language and more concise steps. 2022-08-25 14:10:19 -04:00
Norm 648b2e9f96
Use correct python package name 2022-08-25 14:10:19 -04:00
Norm 58fafc121f
Add python to dependencies
Needed for some node-gyp packages
2022-08-25 14:10:19 -04:00
Norm 7a39c74a78
Add dependency install example for Debian 2022-08-25 14:10:19 -04:00
Norm c4415e9af3
Fix formatting 2022-08-25 14:10:19 -04:00
Norm 8e30c86a9a
Remove non-working IRC link 2022-08-25 14:10:19 -04:00
Norm 2261958670
Update INSTALL.md for FoundKey 2022-08-25 14:10:19 -04:00
Norm e28606e859
Add 'docs/INSTALL.md' 2022-08-25 14:10:14 -04:00
Johann150 5374d8a24c
import some admin docs from misskey-hub
Co-authored-by: Francis Dinh <normandy@biribiri.dev>
Co-authored-by: tamaina <tamaina@hotmail.co.jp>
2022-08-25 10:33:00 +02:00
syuilo cfcc626de2 ドキュメントをmisskey-hubに移管 2021-10-21 23:24:23 +09:00
tamaina 23de94785d
doc: recursive (#7893) 2021-10-21 19:56:30 +09:00
syuilo 9f3b4ccd14 update contribution guide 2021-09-20 23:24:07 +09:00
MeiMei 4beea63d3f
GitHub Actionsを使用してDocker Hubへpushする方法 の説明 (#7790)
* Create push-docker-hub.ja.md

* remove space
2021-09-12 22:43:54 +09:00
syuilo 8407702b38
藍モード (#7687)
* wip

* wip

* シンボリックリンクやめた

* install lib dependency

* bring live2d assets from misskey-dev/assets

* refactor

* nanka iroiro

* コミット忘れ

* random motion

* wip

* run git submodule update --init

* コミット忘れ

* refactor

* fix bug

* Update misskey-assets

* lint

* lint

* lint

* 藍モード修正 (#7702)

* lazy load live2d script

* fix typo

* lazy load also widget

* hot link to cubism core

* https://github.com/misskey-dev/misskey/pull/7702/files#r695623821

* fix lint

* remove live2d stuff

* use iframe

* update

* Update gulpfile.ts

* update

* Update .gitattributes

* update

Co-authored-by: tamaina <tamaina@hotmail.co.jp>
2021-09-04 17:54:24 +09:00
syuilo 7fbee704ec
Update CONTRIBUTING.en.md 2021-08-30 20:09:26 +09:00
syuilo b1f94c7bc6
Update CONTRIBUTING.en.md 2021-08-30 20:04:59 +09:00
syuilo e210ec782a
Update CONTRIBUTING.en.md 2021-08-30 19:53:51 +09:00
syuilo 229780f6ff
Update CONTRIBUTING.en.md 2021-08-30 19:50:50 +09:00