Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update mastodon references in documentation #8

Merged
merged 7 commits into from
Nov 23, 2024
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
2 changes: 1 addition & 1 deletion docs/content/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ cta:
- /guide
secondary:
- Try it out →
- https://nimbus.zone
- https://nimbus.town
---

#title
Expand Down
88 changes: 28 additions & 60 deletions docs/content/1.guide/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,102 +2,70 @@

## What is Nimbus?

Nimbus is an alternative way to access your Mastodon account from your browser.
Nimbus is an alternative way to access your Bluesky account from your browser.

Through the Mastodon API, Nimbus provides similar access to posts and actions on posts you expect to be able to do to Mastodon.
You can compose a post (Toot, if you like), boost others' toots, like, and scroll just as you would through your regular server site.
Through the Bluesky API, Nimbus provides similar access to posts and actions on posts you expect to be able to do to Bluesky. You can compose a post, boost others' posts, like, and scroll just as you would through your regular server site.

Why Nimbus, then?
Nimbus provides some features not available through the standard Mastodon web app interface.
You can use Nimbus right in your browser. On a mobile device, you can install the app to your home screen as a [Progressive Web App (PWA)](../80.pwa.md).

- Notifications for the same post combine when they are sequential. No more seeing your same viral joke multiple times in the Notification feed for each like and boost. Now you can see it just one, with a list of who liked or boosted the post just above the post itself.
- You control whether you see boost, like, and follower accounts - all separately!
- See a preview of the profile when someone follows you.
## What is Bluesky?

You can use Nimbus right in your browser.
On a mobile device, you can install the app to your home screen right from your browser for easy access.
(This is called a Progressive Web App, or [PWA](../80.pwa.md).)

Want to try it out?
Visit https://elk.zone, type in your Mastodon server address, then log in.
Or, visit one of the other Nimbus installs in the [Nimbus ecosystem](https://github.com/elk-zone/elk#ecosystem).

## What is Mastodon?

Mastodon is a decentralized microblogging platform.
Mastodon uses the [ActivityPub protocol](https://www.w3.org/TR/activitypub/) to share posts and actions between users within or across different instance servers.
Bluesky is an open-source microblogging platform built on the [AT protocol](https://atproto.com/). It aims to provide a familiar microblogging experience while also granting users control over their personal data using [Personal Data Servers (PDS)](https://atproto.com/guides/glossary#pds-personal-data-server).

You can think of the service as something similar to Twitter, but with some key differences.

- Where Twitter is a single site that everyone who uses it belongs to, Mastodon is a platform used by many different sites.
- Where Twitter is a corporation with profit goals and advertisements, Mastodon is a free and open source software tool maintained by volunteers and paid for by patrons and voluntary contributors to their own instance servers and back to the main software project.
- Where Twitter users can only interact with other Twitter users, Mastodon users can talk to users on many other ActivityPub platforms, including services that provide video (PeerTube), photos ([PixelFed](https://pixelfed.org/)), blogs ([WriteFreely](https://writefreely.org/)), and alternative microblogging platforms ([Pleroma](https://pleroma.social/), [Hometown](https://github.com/hometown-fork/hometown), [GoToSocial](https://gotosocial.org/), and their derivatives).
- Where Twitter is a corporation with profit goals and advertisements, Bluesky is an open-source project built on open protocols and maintained by a Public Benefit Corporation.
- Where Twitter users can only interact with other Twitter users, Bluesky users are able to communicate with other ATProtocol-powered platforms.

For more details about Mastodon, see their [website](https://joinmastodon.org/), [blog](https://blog.joinmastodon.org), [docs](https://docs.joinmastodon.org), and [GitHub Repository](https://github.com/mastodon/mastodon).
For more details about Bluesky, see their [website](https://bluesky.social/about), [blog](https://bsky.social/about/blog), [GitHub organization](https://github.com/bluesky-social), [documentation](https://docs.bsky.app/docs/get-started) and the [ATProtocol documentation](https://atproto.com/).

## What is a Mastodon Client?
## What is a Bluesky Client?

A Mastodon Client is software that serves up the posts and activities from a Mastodon server using the [Mastodon API](https://docs.joinmastodon.org/api/).
When you visit or sign in to a Mastodon server, you use the standard Mastodon client or the alternative Advanced Web Interface (that provides a multi-column format).
A Bluesky Client is software that serves up the posts and activities from Bluesky using the [Bluesky API](https://docs.bsky.app/docs/category/http-reference). When you visit or sign in to Bluesky, you use the standard Bluesky client.

A Mastodon client performs similar functions as the standard web interfaces.
Using a client, you can
- View posts from accounts you follow
- Repost and like posts
- Create new posts from your own account
- See what is trending on your server
- View, add, or participate in polls
- Follow, unfollow, mute, and block accounts
A Bluesky client performs similar functions as the standard web interfaces. Using a client, you can:

- View posts from accounts you follow.
- Repost and like posts.
- Create new posts from your own account.
- Follow, unfollow, mute, and block accounts.

::alert{type="info"}
**Note:** Not all clients provide all features.
::

### Installed Mastodon Clients
### Installed Bluesky Clients

You may be most familiar with Mastodon Clients through your phone or tablet.
The app you download from an app store and install on your device to access your Mastodon account is a Mastodon Client.
You may be most familiar with Bluesky Clients through your phone or tablet. The app you download from an app store and install on your device to access your Bluesky account is a Bluesky Client.

::card{icon="logos:android-icon"}
#title
Android
#description
[Fedilab](https://fedilab.app/), [Tusky](https://tusky.app/), or [Tooot](https://tooot.app/), among others.
[Graysky](https://graysky.app/) and [Openvibe](https://openvibe.social/).
::

::card{icon="logos:apple"}
#title
Apple
#description
[Ivory](https://tapbots.com/ivory/), [Ice Cubes](https://apps.apple.com/us/app/ice-cubes-for-mastodon/id6444915884), [Metatext](https://github.com/metabolist/metatext), or [Toot](https://apps.apple.com/app/toot/id1229021451?ls=1)
[Skeets](https://www.skeetsapp.com/), [Graysky](https://graysky.app/), [Openvibe](https://openvibe.social/), or [Croissant](https://croissantapp.com/).
::
::card{icon="mdi:desktop-classic"}
#title
Desktop
#description
[TheDesk](https://thedesk.top/en/), [Whalebird](https://whalebird.social/en), or [Sengi](https://nicolasconstant.github.io/sengi/)
[Skeets](https://www.skeetsapp.com/), [Sky.app](https://github.com/jcsalterego/Sky.app).
::

All of these apps provide some combination of the features a typical Mastodon user expects for their account.

### Browser-based Mastodon Clients

Nimbus is a Mastodon Client, but instead of being an app to install on your phone, tablet, or desktop, it is an alternative web site you visit in a browser.

In addition to Nimbus, there are other browser-based alternative Mastodon clients.
Some include:

- [Semaphore](https://semaphore.social/), a continuation of the now-frozen [Pinafore](https://pinafore.social/)
- [Sengi](https://nicolasconstant.github.io/sengi/) (Also available as a desktop client)
- [Cuckoo](https://cuckoo.social)

## Sponsors
All of these apps provide some combination of the features a typical Bluesky user expects for their account.

We want to thank the generous sponsoring and help of:
### Browser-based Bluesky Clients

[![NuxtLabs](/images/nuxtlabs.svg)](https://nuxtlabs.com/)
[![StackBlitz](/images/stackblitz.svg)](https://stackblitz.com/)
Nimbus is a Bluesky Client, but instead of being an app to install on your phone, tablet, or desktop, it is an alternative web site you visit in a browser.

And all the companies and individuals sponsoring Nimbus Team members.
In addition to Nimbus, there are other browser-based alternative Bluesky clients. Some include:

[Find out more about sponsoring Nimbus](/guide/sponsoring).
- [deck.blue](https://deck.blue/), a multi-column interface for Bluesky.
- [SkyFeed](https://skyfeed.app/), an alternative Bluesky app with a powerful feed builder.
- [Ouranos](https://useouranos.app/), a Bluesky client with a focus on simplicity.
8 changes: 4 additions & 4 deletions docs/content/1.guide/3.contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ We're really excited that you're interested in contributing to Nimbus! Before su

## Online

You can use [StackBlitz Codeflow](https://stackblitz.com/codeflow) to fix bugs or implement features. You'll also see a Codeflow button on PRs to review them without a local setup. Once the elk repo has been cloned in Codeflow, the dev server will start automatically and print the URL to open the App. You should receive a prompt in the bottom-right suggesting to open it in the Editor or in another Tab. To learn more, check out the [Codeflow docs](https://developer.stackblitz.com/codeflow/what-is-codeflow).
You can use [StackBlitz Codeflow](https://stackblitz.com/codeflow) to fix bugs or implement features. You'll also see a Codeflow button on pull requests (PRs) to review them without a local setup. Once the Nimbus repo has been cloned in Codeflow, the dev server will start automatically and print the URL to open the App. You should receive a prompt in the bottom-right suggesting to open it in the Editor or in another Tab. To learn more, check out the [Codeflow docs](https://developer.stackblitz.com/codeflow/what-is-codeflow).

[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https://pr.new/elk-zone/elk)
[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https://pr.new/nimbus-town/nimbus)

## Local Setup

Expand All @@ -17,7 +17,7 @@ pnpm i
pnpm run dev
```

`Warning`: you will need `corepack` enabled, check out the [Nimbus Contributing Guide](https://github.com/elk-zone/elk/blob/main/CONTRIBUTING.md) for a detailed guide on how to set up the project locally.
`Warning`: you will need `corepack` enabled, check out the [Nimbus Contributing Guide](https://github.com/nimbus-town/nimbus/blob/main/CONTRIBUTING.md) for a detailed guide on how to set up the project locally.

We recommend installing [ni](https://github.com/antfu/ni#ni), that will use the right package manager in each of your projects. If `ni` is installed, you can instead run:

Expand Down Expand Up @@ -48,6 +48,6 @@ nr test
- [Vue Macros](https://vue-macros.sxzz.moe/) - More macros and syntax sugar for Vue
- [UnoCSS](https://uno.antfu.me/) - The instant on-demand atomic CSS engine
- [Iconify](https://github.com/iconify/icon-sets#iconify-icon-sets-in-json-format) - Iconify icon sets in JSON format
- [Masto.js](https://neet.github.io/masto.js) - Mastodon API client in TypeScript
- [ATP API](https://github.com/bluesky-social/atproto/tree/main/packages/api) - ATProtocol API client in TypeScript
- [shiki](https://shiki.style/) - A beautiful yet powerful syntax highlighter
- [vite-plugin-pwa](https://github.com/vite-pwa/vite-plugin-pwa) - Prompt for update, Web Push Notifications and Web Share Target API
9 changes: 6 additions & 3 deletions docs/content/2.deployment/1.netlify.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Netlify and Cloudflare

Want to host Nimbus for your Mastodon instance? You came to the right place!
Want to host Nimbus by yourself? You came to the right place!

For this guide we're going to use Netlify for hosting the app, and Cloudflare for key value storage. Both of which can be used on their free tiers if your instance is small.

## Forking Nimbus

In order to use Netlify with Nimbus, we'll need to fork the Nimbus repo.

Fork the repository from [https://github.com/elk-zone/elk](https://github.com/elk-zone/elk). Make sure you deselect "Copy the main branch only" if you want to use the stable `release` branch.
Fork the repository from [https://github.com/nimbus-town/nimbus](https://github.com/nimbus-town/nimbus). Make sure you deselect "Copy the main branch only" if you want to use the stable `release` branch.

![The settings to use for forking the Nimbus repository](/images/selfhosting-guide/github-fork.png)

## Importing the Nimbus repo into Netlify
Expand Down Expand Up @@ -51,11 +52,13 @@ There are 5 environment variables to add.
That's it! All that's left to do is...

## Deploy Nimbus!

On your project page open the Deploys tab, click on "Trigger deploy" and "Deploy site". In a few minutes Nimbus should be up and running!

## Use a custom domain

If you want to use a custom domain, go to "Domain settings" on your Netlify project page, and press "Add custom domain". If your domain is not bought from Netlify, it will ask you to add a CNAME record. Do that.

Once the custom domain is added, you'll need to add an SSL/TLS certificate. At the bottom of the page press "Verify DNS configuration" and if it succeeds, press "Provision certificate". If that fails, you may need to wait some time until your DNS propagates.

And that's it! Enjoy your instance's Nimbus!
And that's it! Enjoy Nimbus!
Loading