diff --git a/404.html b/404.html index a2721df..fa33709 100644 --- a/404.html +++ b/404.html @@ -3,4 +3,4 @@

Page not found :(

The page you are looking for doesn't exist or has been moved.

- \ No newline at end of file + \ No newline at end of file diff --git a/categories/index.html b/categories/index.html index c671f15..115c9ff 100644 --- a/categories/index.html +++ b/categories/index.html @@ -3,4 +3,4 @@

Categories

- \ No newline at end of file + \ No newline at end of file diff --git a/contributors/index.html b/contributors/index.html index d48e82d..b57f411 100644 --- a/contributors/index.html +++ b/contributors/index.html @@ -3,4 +3,4 @@

Contributors

- \ No newline at end of file + \ No newline at end of file diff --git a/docs/comparsion/index.html b/docs/comparsion/index.html index fd50e9e..c9bff87 100644 --- a/docs/comparsion/index.html +++ b/docs/comparsion/index.html @@ -1,10 +1,12 @@ Comparsion - Sharkey Documentation
- \ No newline at end of file + \ No newline at end of file diff --git a/docs/comparsion/misskey/index.html b/docs/comparsion/misskey/index.html index 69c1eb1..e16143d 100644 --- a/docs/comparsion/misskey/index.html +++ b/docs/comparsion/misskey/index.html @@ -1,11 +1,14 @@ Sharkey vs Misskey - Sharkey Documentation

Sharkey vs Misskey

+been removed (smaller installation, faster image/video uploads)
  • argon2 instead of bcrypt for hashing users’ secrets
  • admins can delete remote emojis
  • admins can disable achievements
  • admins can refresh remote user details
  • admins can set a default emoji for likes/reactions
  • the PWA icon matches the instance icon
  • deleted custom emoji are automatically removed from Drive
    • ← Migrating from another software
    FAQs →
    - \ No newline at end of file + \ No newline at end of file diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html new file mode 100644 index 0000000..df69d50 --- /dev/null +++ b/docs/getting-started/index.html @@ -0,0 +1,12 @@ +Getting started - Sharkey Documentation
    + + + \ No newline at end of file diff --git a/docs/getting-started/index.xml b/docs/getting-started/index.xml new file mode 100644 index 0000000..1072446 --- /dev/null +++ b/docs/getting-started/index.xml @@ -0,0 +1,3 @@ +Getting started onhttps://docs.joinsharkey.org/docs/getting-started/Recent content in Getting started onHugo -- gohugo.ioOverviewhttps://docs.joinsharkey.org/docs/getting-started/overview/Mon, 01 Jan 0001 00:00:00 +0000https://docs.joinsharkey.org/docs/getting-started/overview/Welcome to Sharkey’s documentation! +Sharkey is a Misskey fork following upstream changes when possible, with added features. Like any other ActivityPub software Sharkey can interface with the thousands of servers that form the fediverse, an interconnected social network, working in tandem with software such as Akkoma, Mastodon, Pixelfed and many more. +Have you heard of Sharkey, but you’re not sure how it differs from Misskey? Go to the comparison page. \ No newline at end of file diff --git a/docs/getting-started/overview/index.html b/docs/getting-started/overview/index.html new file mode 100644 index 0000000..a5ed168 --- /dev/null +++ b/docs/getting-started/overview/index.html @@ -0,0 +1,28 @@ +Overview - Sharkey Documentation

    Overview

    Welcome to Sharkey’s documentation!

    Sharkey is a Misskey fork following upstream changes when possible, +with added features. Like any other ActivityPub software Sharkey can +interface with the thousands of servers that form the fediverse, an +interconnected social network, working in tandem with software such as +Akkoma, Mastodon, Pixelfed and many more.

    Have you heard of Sharkey, but you’re not sure how it differs from +Misskey? Go to the comparison page.

    Do you want to find an instance running Sharkey, and create an account +there? Go to our directory site.

    Do you want to install Sharkey? Go to the “Fresh Install” +instructions.

    Are you running a Misskey or Firefish instance, and want to migrate to +Sharkey? Go the migration instructions.

    Have you just started using Sharkey, and are confused? Try the +FAQs.

    Fresh Installation →
    + + + \ No newline at end of file diff --git a/docs/getting-started/sitemap.xml b/docs/getting-started/sitemap.xml new file mode 100644 index 0000000..52a0499 --- /dev/null +++ b/docs/getting-started/sitemap.xml @@ -0,0 +1 @@ +https://docs.joinsharkey.org/docs/getting-started/overview/ \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index d4e9a7a..f62333d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,10 +1,12 @@ Docs - Sharkey Documentation
    +
    - \ No newline at end of file + \ No newline at end of file diff --git a/docs/install/faqs/index.html b/docs/install/faqs/index.html new file mode 100644 index 0000000..4e81f38 --- /dev/null +++ b/docs/install/faqs/index.html @@ -0,0 +1,32 @@ +FAQs - Sharkey Documentation

    FAQs

    You use the “roles” system. Log in as administrator, go to the +“control panel”, select the “roles” section (under “management”). Then +either expand the “role template” (if you want to give every user +access to search) or create a new role (if you want to give access to +only some users), then change the “Usage of note search” setting.

    How do I give my users more Drive space?

    You use the “roles” system. Log in as administrator, go to the +“control panel”, select the “roles” section (under “management”). Then +either expand the “role template” (if you want to give every user the +same amount space) or create a new role (if you want to give different +amounts of space to different users), then change the “Drive +capacity” setting.

    How do I enable push notifications for the web interface?

    First of all, you need to generate a pair of so-called “VAPID” keys.

    One way to do that is, from your Sharkey directory (git clone, or +inside the Docker image):

    ./packages/backend/node_modules/.bin/web-push generate-vapid-keys
+

    Alternatively, you can use an online +generator.

    Once you have that public and private keys, log in as administrator, +go to the “control panel”, select the “general” section (under +“settings”), scroll to the “ServiceWorker” bit, enter both keys, and +enable the “Enable Push-Notifications for your Browser” toggle.

    ← Sharkey vs Misskey
    + + + \ No newline at end of file diff --git a/docs/install/fresh/index.html b/docs/install/fresh/index.html index e7308ac..336d163 100644 --- a/docs/install/fresh/index.html +++ b/docs/install/fresh/index.html @@ -7,13 +7,16 @@ Docker Compose Plugin Create multiple directories: mkdir Sharkey && mkdir Sharkey/.config Fetch all required examples and enter directory: wget -O Sharkey/docker-compose.">

    Fresh Installation

    +previous build, then you can install+build+migrate+restart again.

    ← Overview
    Migrating from another software →
    - \ No newline at end of file + \ No newline at end of file diff --git a/docs/install/index.html b/docs/install/index.html index cefca2a..91f5f65 100644 --- a/docs/install/index.html +++ b/docs/install/index.html @@ -1,10 +1,12 @@ Install - Sharkey Documentation
    +
    - \ No newline at end of file + \ No newline at end of file diff --git a/docs/install/index.xml b/docs/install/index.xml index db2c379..208a19a 100644 --- a/docs/install/index.xml +++ b/docs/install/index.xml @@ -6,4 +6,6 @@ mkdir Sharkey && mkdir Sharkey/.config Fetch all required exampl wget -O Sharkey/docker-compose.Migrating from another softwarehttps://docs.joinsharkey.org/docs/install/migrate/Mon, 01 Jan 0001 00:00:00 +0000https://docs.joinsharkey.org/docs/install/migrate/From Misskey # Let’s say you have a working Misskey, running as user misskey from /home/misskey/misskey. Migrating to Sharkey is the same as updating to a newer Misskey version: -sudo -u misskey -i cd misskey git remote rename origin misskey git remote add origin https://github.com/transfem-org/Sharkey.git git remote update -p git checkout -b stable --track origin/stable git pull --recurse-submodules pnpm install --frozen-lockfile pnpm run build pnpm run migrate Then you can restart your service. \ No newline at end of file +sudo -u misskey -i cd misskey git remote rename origin misskey git remote add origin https://github.com/transfem-org/Sharkey.git git remote update -p git checkout -b stable --track origin/stable git pull --recurse-submodules pnpm install --frozen-lockfile pnpm run build pnpm run migrate Then you can restart your service.FAQshttps://docs.joinsharkey.org/docs/install/faqs/Mon, 01 Jan 0001 00:00:00 +0000https://docs.joinsharkey.org/docs/install/faqs/How do I enable note search? # +You use the “roles” system. Log in as administrator, go to the “control panel”, select the “roles” section (under “management”). Then either expand the “role template” (if you want to give every user access to search) or create a new role (if you want to give access to only some users), then change the “Usage of note search” setting. +How do I give my users more Drive space? \ No newline at end of file diff --git a/docs/install/migrate/index.html b/docs/install/migrate/index.html index b9f199b..909ad76 100644 --- a/docs/install/migrate/index.html +++ b/docs/install/migrate/index.html @@ -3,13 +3,16 @@ sudo -u misskey -i cd misskey git remote rename origin misskey git remote add origin https://github.com/transfem-org/Sharkey.git git remote update -p git checkout -b stable --track origin/stable git pull --recurse-submodules pnpm install --frozen-lockfile pnpm run build pnpm run migrate Then you can restart your service.">

    Migrating from another software

    - \ No newline at end of file + \ No newline at end of file diff --git a/docs/install/sitemap.xml b/docs/install/sitemap.xml index 3bbfc70..a5baee9 100644 --- a/docs/install/sitemap.xml +++ b/docs/install/sitemap.xml @@ -1 +1 @@ -https://docs.joinsharkey.org/docs/install/fresh/https://docs.joinsharkey.org/docs/install/migrate/ \ No newline at end of file +https://docs.joinsharkey.org/docs/install/fresh/https://docs.joinsharkey.org/docs/install/migrate/https://docs.joinsharkey.org/docs/install/faqs/ \ No newline at end of file diff --git a/docs/sitemap.xml b/docs/sitemap.xml index a541a7d..e30ea96 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -1 +1 @@ -https://docs.joinsharkey.org/docs/install/https://docs.joinsharkey.org/docs/comparsion/https://docs.joinsharkey.org/docs/install/fresh/https://docs.joinsharkey.org/docs/install/migrate/https://docs.joinsharkey.org/docs/comparsion/misskey/ \ No newline at end of file +https://docs.joinsharkey.org/docs/getting-started/https://docs.joinsharkey.org/docs/install/https://docs.joinsharkey.org/docs/comparsion/https://docs.joinsharkey.org/docs/getting-started/overview/https://docs.joinsharkey.org/docs/install/fresh/https://docs.joinsharkey.org/docs/install/migrate/https://docs.joinsharkey.org/docs/install/faqs/https://docs.joinsharkey.org/docs/comparsion/misskey/ \ No newline at end of file diff --git a/index.html b/index.html index e3bd166..d62e01c 100644 --- a/index.html +++ b/index.html @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/index.min.e40fc298d2740acad53eb36f350844488bd52e0fcc5cb58ea86c65033814179721fa0ffb928310d4237ad15285b065a8c888f8b232df5a7fcd370e51b004469c.js b/index.min.6fdac63914a5ce0df55b467c405475a4bd52c91bb063eb8f0880f7a15e59e2c42935c3bc6e8e3f1269e512b792bbc01437c8532f870b5b7c08939ea62b5fe90c.js similarity index 81% rename from index.min.e40fc298d2740acad53eb36f350844488bd52e0fcc5cb58ea86c65033814179721fa0ffb928310d4237ad15285b065a8c888f8b232df5a7fcd370e51b004469c.js rename to index.min.6fdac63914a5ce0df55b467c405475a4bd52c91bb063eb8f0880f7a15e59e2c42935c3bc6e8e3f1269e512b792bbc01437c8532f870b5b7c08939ea62b5fe90c.js index a0f1cdd..81fe611 100644 --- a/index.min.e40fc298d2740acad53eb36f350844488bd52e0fcc5cb58ea86c65033814179721fa0ffb928310d4237ad15285b065a8c888f8b232df5a7fcd370e51b004469c.js +++ b/index.min.6fdac63914a5ce0df55b467c405475a4bd52c91bb063eb8f0880f7a15e59e2c42935c3bc6e8e3f1269e512b792bbc01437c8532f870b5b7c08939ea62b5fe90c.js @@ -1,4 +1,13 @@ -var suggestions=document.getElementById("suggestions"),search=document.getElementById("search");search!==null&&document.addEventListener("keydown",inputFocus);function inputFocus(e){e.ctrlKey&&e.key==="/"&&(e.preventDefault(),search.focus()),e.key==="Escape"&&(search.blur(),suggestions.classList.add("d-none"))}document.addEventListener("click",function(e){var t=suggestions.contains(e.target);t||suggestions.classList.add("d-none")}),document.addEventListener("keydown",suggestionFocus);function suggestionFocus(e){const s=suggestions.classList.contains("d-none");if(s)return;const t=[...suggestions.querySelectorAll("a")];if(t.length===0)return;const n=t.indexOf(document.activeElement);if(e.key==="ArrowUp"){e.preventDefault();const s=n>0?n-1:0;t[s].focus()}else if(e.key==="ArrowDown"){e.preventDefault();const s=n+10?n-1:0;t[s].focus()}else if(e.key==="ArrowDown"){e.preventDefault();const s=n+1e.result)){if(t.has(e.doc.href))continue;t.set(e.doc.href,e.doc)}if(suggestions.innerHTML="",suggestions.classList.remove("d-none"),t.size===0&&n){const e=document.createElement("div");e.innerHTML=`No results for "${n}"`,e.classList.add("suggestion__no-results"),suggestions.appendChild(e);return}for(const[r,a]of t){const n=document.createElement("div");suggestions.appendChild(n);const e=document.createElement("a");e.href=r,n.appendChild(e);const o=document.createElement("span");o.textContent=a.title,o.classList.add("suggestion__title"),e.appendChild(o);const i=document.createElement("span");if(i.textContent=a.description,i.classList.add("suggestion__description"),e.appendChild(i),suggestions.appendChild(n),suggestions.childElementCount==s)break}}})() \ No newline at end of file +`}),e.add({id:5,href:"/docs/comparsion/",title:"Comparsion",description:"",content:""}),e.add({id:6,href:"/docs/comparsion/misskey/",title:"Sharkey vs Misskey",description:`A (probably comprehensive) list of differences # Big ones # fully federated note editing, you can also see previous versions of edited notes Mastodon-compatible API, including OAuth2 can import your exported posts from Mastodon and most of its forks, Pleroma / Akkoma, Misskey / Firefish and forks, Twitter, Instagram, Facebook, including attachments (threading may not work perfectly, and other people\u0026rsquo;s replies to your posts may not get imported) admins can require approval for new users\u0026rsquo; signups admins can silence users admins can mark all of a user\u0026rsquo;s media as NSFW GDPR-style Data Subject Access Requests (users can export all data related to themselves) Fun ones # can play module / tracker music files (federated) listenbrainz integration (federated) background image on user profiles \u0026ldquo;speak as cat\u0026rdquo; separate from \u0026ldquo;is a cat\u0026rdquo; (both setting are federated with compatible software) UI/UX # option to open a note\u0026rsquo;s detailed view by clicking on the note (most useful on mobile) images lacking alt text are marked as such UI elements can be round (as in Misskey) or square-ish \u0026ldquo;sign out\u0026rdquo; button in user menu user profile page has \u0026ldquo;notes\u0026rdquo; / \u0026ldquo;all\u0026rdquo; / \u0026ldquo;including files\u0026rdquo; tabs attachments can be collapsed by default buttons to show/hide all notes with CWs in a conversation one-button \u0026ldquo;like\u0026rdquo; (plus custom reactions on a separate button) animated MFM can be enabled/disabled on each note supports longer alt text pop-up user profiles show if follow requests to the user require approval, have a \u0026ldquo;open remote profile\u0026rdquo; option, and show custom fields (e.`,content:`A (probably comprehensive) list of differences # Big ones # fully federated note editing, you can also see previous versions of edited notes Mastodon-compatible API, including OAuth2 can import your exported posts from Mastodon and most of its forks, Pleroma / Akkoma, Misskey / Firefish and forks, Twitter, Instagram, Facebook, including attachments (threading may not work perfectly, and other people\u0026rsquo;s replies to your posts may not get imported) admins can require approval for new users\u0026rsquo; signups admins can silence users admins can mark all of a user\u0026rsquo;s media as NSFW GDPR-style Data Subject Access Requests (users can export all data related to themselves) Fun ones # can play module / tracker music files (federated) listenbrainz integration (federated) background image on user profiles \u0026ldquo;speak as cat\u0026rdquo; separate from \u0026ldquo;is a cat\u0026rdquo; (both setting are federated with compatible software) UI/UX # option to open a note\u0026rsquo;s detailed view by clicking on the note (most useful on mobile) images lacking alt text are marked as such UI elements can be round (as in Misskey) or square-ish \u0026ldquo;sign out\u0026rdquo; button in user menu user profile page has \u0026ldquo;notes\u0026rdquo; / \u0026ldquo;all\u0026rdquo; / \u0026ldquo;including files\u0026rdquo; tabs attachments can be collapsed by default buttons to show/hide all notes with CWs in a conversation one-button \u0026ldquo;like\u0026rdquo; (plus custom reactions on a separate button) animated MFM can be enabled/disabled on each note supports longer alt text pop-up user profiles show if follow requests to the user require approval, have a \u0026ldquo;open remote profile\u0026rdquo; option, and show custom fields (e.g. the user\u0026rsquo;s website address) MFM cheatsheet when composing notes emoji auto-complete is case-insensitive it\u0026rsquo;s always clear if a note has a poll (misskey sometimes hides that) multiple-choice polls are clearly marked as such boosts and quote-boost are accounted separately only 1 boost per note per user is allowed admins can remove bots from \u0026ldquo;trending\u0026rdquo; users can hide bots from their timelines translatable notes are shown translated regardless of where they\u0026rsquo;re shown (e.g. when quoted, or when looking at their replies) when searching, users can restrict results to notes with attachments CSS class names are human-readable, to simplify browser-side customisation users can disable indexing of their notes (the setting is federated) \u0026ldquo;likes\u0026rdquo; and \u0026ldquo;reactions\u0026rdquo; federate correctly to Mastodon / Pleroma / Akkoma (Misskey sends them all as reactions) different error icons users can disable the \u0026ldquo;disconnected\u0026rdquo; warning (connection is usually re-established automatically, so the warning is rarely useful) users can set a default emoji for their likes/reactions when the instance is using meilisearch to index notes, Sharkey will use it in more cases (e.g. when limiting results to notes containing images) when showing a reply containing many mentions, they are shortened there\u0026rsquo;s a search widget Ones of interest to admins # quote-boosts federate correctly from/to Mastodon forks the not-very-functional \u0026ldquo;automatically mark attachments as NSFW\u0026rdquo; has been removed (smaller installation, faster image/video uploads) argon2 instead of bcrypt for hashing users\u0026rsquo; secrets admins can delete remote emojis admins can disable achievements admins can refresh remote user details admins can set a default emoji for likes/reactions the PWA icon matches the instance icon deleted custom emoji are automatically removed from Drive `}),e.add({id:7,href:"/docs/install/faqs/",title:"FAQs",description:`How do I enable note search? # You use the \u0026ldquo;roles\u0026rdquo; system. Log in as administrator, go to the \u0026ldquo;control panel\u0026rdquo;, select the \u0026ldquo;roles\u0026rdquo; section (under \u0026ldquo;management\u0026rdquo;). Then either expand the \u0026ldquo;role template\u0026rdquo; (if you want to give every user access to search) or create a new role (if you want to give access to only some users), then change the \u0026ldquo;Usage of note search\u0026rdquo; setting. +How do I give my users more Drive space?`,content:`How do I enable note search? # You use the \u0026ldquo;roles\u0026rdquo; system. Log in as administrator, go to the \u0026ldquo;control panel\u0026rdquo;, select the \u0026ldquo;roles\u0026rdquo; section (under \u0026ldquo;management\u0026rdquo;). Then either expand the \u0026ldquo;role template\u0026rdquo; (if you want to give every user access to search) or create a new role (if you want to give access to only some users), then change the \u0026ldquo;Usage of note search\u0026rdquo; setting. +How do I give my users more Drive space? # You use the \u0026ldquo;roles\u0026rdquo; system. Log in as administrator, go to the \u0026ldquo;control panel\u0026rdquo;, select the \u0026ldquo;roles\u0026rdquo; section (under \u0026ldquo;management\u0026rdquo;). Then either expand the \u0026ldquo;role template\u0026rdquo; (if you want to give every user the same amount space) or create a new role (if you want to give different amounts of space to different users), then change the \u0026ldquo;Drive capacity\u0026rdquo; setting. +How do I enable push notifications for the web interface? # First of all, you need to generate a pair of so-called \u0026ldquo;VAPID\u0026rdquo; keys. +One way to do that is, from your Sharkey directory (git clone, or inside the Docker image): +./packages/backend/node_modules/.bin/web-push generate-vapid-keys Alternatively, you can use an online generator. +Once you have that public and private keys, log in as administrator, go to the \u0026ldquo;control panel\u0026rdquo;, select the \u0026ldquo;general\u0026rdquo; section (under \u0026ldquo;settings\u0026rdquo;), scroll to the \u0026ldquo;ServiceWorker\u0026rdquo; bit, enter both keys, and enable the \u0026ldquo;Enable Push-Notifications for your Browser\u0026rdquo; toggle. +`}),e.add({id:8,href:"/docs/",title:"Docs",description:"Docs.",content:""}),search.addEventListener("input",t,!0);function t(){const s=5;var n=this.value,o=e.search(n,{limit:s,enrich:!0});const t=new Map;for(const e of o.flatMap(e=>e.result)){if(t.has(e.doc.href))continue;t.set(e.doc.href,e.doc)}if(suggestions.innerHTML="",suggestions.classList.remove("d-none"),t.size===0&&n){const e=document.createElement("div");e.innerHTML=`No results for "${n}"`,e.classList.add("suggestion__no-results"),suggestions.appendChild(e);return}for(const[r,a]of t){const n=document.createElement("div");suggestions.appendChild(n);const e=document.createElement("a");e.href=r,n.appendChild(e);const o=document.createElement("span");o.textContent=a.title,o.classList.add("suggestion__title"),e.appendChild(o);const i=document.createElement("span");if(i.textContent=a.description,i.classList.add("suggestion__description"),e.appendChild(i),suggestions.appendChild(n),suggestions.childElementCount==s)break}}})() \ No newline at end of file diff --git a/robots.txt b/robots.txt index 2c99721..fc896ea 100644 --- a/robots.txt +++ b/robots.txt @@ -1,5 +1,9 @@ User-Agent: * +Disallow: /docs/getting-started/ + +Disallow: /docs/getting-started/overview/ + Disallow: /docs/install/ Disallow: /docs/install/fresh/ @@ -10,6 +14,8 @@ Disallow: /docs/comparsion/ Disallow: /docs/comparsion/misskey/ +Disallow: /docs/install/faqs/ + Disallow: /docs/ Disallow: / diff --git a/tags/index.html b/tags/index.html index 6680608..4a41e3d 100644 --- a/tags/index.html +++ b/tags/index.html @@ -3,4 +3,4 @@

    Tags

    - \ No newline at end of file + \ No newline at end of file