You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Misty De Méo fa7fa4f1b8
README: avoid implying quote posts don't exist (#1390)
3 weeks ago
.devcontainer Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.github Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.husky Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.rubocop Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.storybook Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.yarn Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
app Mastodon 4.5.7 (#1389) 3 weeks ago
bin Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
chart helm: cleanup helm chart, now in mastodon/chart (#21801) 3 years ago
config Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
db Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
dist Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
docs Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
lib Mastodon 4.5.7 (#1389) 3 weeks ago
log Initial commit 10 years ago
public Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
spec Mastodon 4.5.7 (#1389) 3 weeks ago
streaming Mastodon 4.5.7 (#1389) 3 weeks ago
vendor Increase files checked by ESLint (#9705) 7 years ago
.annotaterb.yml Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.browserslistrc Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.buildpacks Remove nodejs buildpack from buildpacks (#14364) 6 years ago
.dockerignore Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.editorconfig Enable EditorConfig trailing whitespace trimming (#23543) 3 years ago
.env.development Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.env.production.sample Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.env.test Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.env.vagrant Add elastic search installation into Vagrantfile (#26512) 3 years ago
.foreman Replace sprockets/browserify with Webpack (#2617) 9 years ago
.gitattributes Add .gitattributes file to avoid unwanted CRLF (#3954) 9 years ago
.gitignore Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.haml-lint.yml Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.nvmrc Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.prettierignore Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.prettierrc.js Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.rspec Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.rubocop.yml Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.rubocop_todo.yml Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.ruby-gemset Make Mastodon use its own gemset (#17858) 4 years ago
.ruby-version Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.slugignore Remove Storybook (#4397) 9 years ago
.watchmanconfig Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
.yarnrc.yml Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
AUTHORS.md Update AUTHORS.md (#27018) 3 years ago
Aptfile Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
CHANGELOG.md Mastodon 4.5.7 (#1389) 3 weeks ago
CODE_OF_CONDUCT.md Update Contributor Covenant to 2.1 (#23980) 3 years ago
CONTRIBUTING.md Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
Dockerfile Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
FEDERATION.md Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
Gemfile Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
Gemfile.lock Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 10 years ago
Procfile Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
Procfile.dev Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
README.md README: avoid implying quote posts don't exist (#1390) 3 weeks ago
Rakefile Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
SECURITY.md Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
Vagrantfile Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
app.json Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
config.ru Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
crowdin.yml Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
docker-compose.yml Mastodon 4.5.7 (#1389) 3 weeks ago
eslint.config.mjs Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
ide-helper.js Add JS IDE helper (#13012) 6 years ago
jsconfig.json Correct prettier calls for YML/JSON (#21832) 3 years ago
lint-staged.config.js Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
package.json Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
priv-config TOR federation (#7875) 8 years ago
scalingo.json Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
stylelint.config.js Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
tsconfig.json Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
vite.config.mts Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
vitest.config.mts Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
vitest.shims.d.ts Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago
yarn.lock Bringing Hometown up to date with mastodon/mastodon (#1371) 3 weeks ago

README.md

Hometown: a Mastodon fork

photo of a village of stone huts nestled in a lush green valley

Photo by Joana Mujollari, CC0 / Public Domain.

Mastodon is a free, open-source social network server based on ActivityPub. This is not the official version of Mastodon; this is a separate version (i.e. a fork) maintained by Darius Kazemi. For more information on Mastodon, you can see the official website and the upstream repo.

Hometown is a light weight fork of Mastodon. By "light weight" I don't mean more efficient; I mean this fork is 99.999% identical to Mastodon with a few key tweaks. This project is based on the principle of: minimum code change for maximum user experience change. This makes it easy for the basically-one-person who runs the project to keep it up to date. By our best understanding, our major changes are not wanted by the Mastodon project, hence maintaining this fork instead of trying to commit the changes to Mastodon.

Please check out our wiki for a list of Hometown-exclusive features. Some but not all of these are covered in this document.

You can also find a list of running Hometown instances, don't hesitate to open an issue to add yours!

Support this project

Please consider supporting Hometown by pledging to my Patreon, which supports all my open source projects including this one!

Of course this project couldn't exist without Mastodon so maybe support the Mastodon project Patreon too.

Migrating from Mastodon to Hometown

Please see this article in the wiki for directions on migration from Mastodon to Hometown.

Local only posting

Mastodon right now is designed to get your messages out to the entire fediverse. This is great, but there is a huge need for more private communities. And in a federated network I think it makes the most sense for your home server to be that community (hence "Hometown").

In the context of Hometown, local only posting is a per-post security option that lets you set whether that post can federate out to other servers or not.

I've been running Friend Camp, a Mastodon fork with local only posting, for about a year. Being able to have conversations with people on your server that don't federate is a hugely liberating thing. It allows inside jokes to develop. It allows people the freedom to complain about things that they wouldn't necessarily feel comfortable leaving a trusted server (cops, employers, etc). It also lets us do things like have a server-wide movie night where we flood the local timeline with posts about the movie, and it doesn't pollute the rest of the Fediverse.

This feature is based on the work of Renato Lond, which is itself based on a feature in the Mastodon Glitch Edition fork.

Reading more content types

Mastodon is microblogging software, meant for Twitter-style shortform posting.

Hometown is microblogging for writing, but its goal is to accept many content types for reading. So while I don't plan to let Hometown users publish massive blog posts, I would like your Hometown instance to be your one-stop shop for viewing all sorts of things on the Fediverse.

For Hometown this means if you subscribe to a service that sends out Article objects over ActivityPub (such as a blog on Write As), then those full articles render in your home timeline, behind a cut for length. Also, Hometown will render a variety of rich text like italic and bold.

Click on this GIF for a brief video demo:

Video demo of someone clicking 'read article' on an incoming article post, which then renders a full article.

This is based on rich text work by Claire Girka, and my own work on Article support.

It's more than just reading more stuff

Reading more content types also helps make the fediverse better. ActivityPub supports all kinds of content, but most ActivityPub servers shoehorn all their content into Note because that's the type that Mastodon treats as first-class. This has important implications for the fediverse and also on your day to do user experience.

Take the "quote post" debate for example.

Mastodon has a feature called "quote tweeting" that lets you embed what someone else posts, with your own comment right next to it. It's really useful for provide commentary in context, like this, where I point people to a sale and they can read both my comment on the sale and the original tweet about the sale in one post:

An example of a quote tweet from Twitter.

Hometown doesn't support quoting articles yet... but it will.

Better list management

If Hometown is going to be a universal reader, you're going to need better control over organizing your feeds than mainline Mastodon provides.

I've introduced a new kind of exclusive list. In vanilla Mastodon, if you add an account to your "friends I like" list, posts from people on that list appear on that list. But they also appear on your home timeline, and maybe you don't want that! You'd rather treat your "friends I like" list as your "real" home timeline, and then check your home timeline when you're bored. Check out more details about exclusive lists on the wiki.

Better accessibility defaults

Look, right now this pretty much just means that we underline hyperlinks by default. I'm of course open to implementing other obviously beneficial accessibilty defaults that Mastodon itself doesn't implement.

Hometown is still 99.999% Mastodon

I don't intend to stray very far from mainline Mastodon with this fork. If you want something that provides a ton of new features and widgets and stuff, the Mastodon Glitch Edition fork is a wondrous kitchen sink of major and minor tweaks.

Part of why I don't want to stray far from mainline Mastodon is that this project is going to be just me for the foreseeable future, and I'd like to keep it up to date with new Mastodon versions as easily as possible. The less code I change from Mastodon, the easier that is. Hence the principle of "minimum code change for maximum user experience change."

Versioning

Hometown uses semantic versioning and follows a versioning convention like v1.0.0+2.9.3. The 1.0.0 part is the actual Hometown version number, and then the 2.9.3 after the + sign is what's known in semantic versioning as "build metadata". It just means that a particular release is synchronized with Mastodon version 2.9.3, so for example an upgrade from v1.0.0+2.9.2 to v1.0.0+2.9.3 would upgrade Mastodon but not provide any new Hometown features or fixes.

Contributing to Hometown

Setting up your Hometown development environment is exactly like setting up your Mastodon development environment. Pull requests should be made to the hometown-dev branch, which is our default branch in Github.

You should read the overall CONTRIBUTING guide, which covers our development processes.

You should also read and understand the CODE OF CONDUCT that enables us to maintain a welcoming and inclusive community. Collaboration begins with mutual respect and understanding.

You can learn about setting up a development environment in the DEVELOPMENT documentation.

Copyright (C) 2016-2023 Eugen Rochko & other Mastodon contributors (see AUTHORS.md)

LICENSE

Copyright (c) 2016-2025 Eugen Rochko (+ mastodon authors)

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.