A supported fork of Mastodon that provides local posting and a wider range of content types.

Darius Kazemi 441dca176d Merge tag 'v4.2.10' into hometown-4.2-merge 8 months ago
.devcontainer 075cc8e8a6 Improve Codespaces port forwarding (#26400) 1 year ago
.github b651cffa87 Remove workflows that are not necessary for this fork 1 year ago
.husky a766804e02 Use Yarn instead of NPX for pre-commit hook (#24287) 1 year ago
app 441dca176d Merge tag 'v4.2.10' into hometown-4.2-merge 8 months ago
bin b6b4ea4ca5 Move the mastodon/*_cli files to mastodon/cli/* (#24139) 1 year ago
chart 64bea71714 helm: cleanup helm chart, now in mastodon/chart (#21801) 2 years ago
config c72697c2d2 Merge latest changes from 'stable-4.2' 8 months ago
db cf3234adfd Custom theme fixes plus some db cruft 8 months ago
dist cb9f96036c Add suggestion for secure cyphers to nginx.conf (#26349) 1 year ago
lib 441dca176d Merge tag 'v4.2.10' into hometown-4.2-merge 8 months ago
log 9c4856bdb1 Initial commit 9 years ago
public dae0793b5e Merge tag 'v4.2.0-beta2' into lets-bump-hometown-to-mastodon-4.2 1 year ago
spec 441dca176d Merge tag 'v4.2.10' into hometown-4.2-merge 8 months ago
streaming cc42aa5c08 Merge tag 'v4.2.1' into lets-bump-hometown-to-mastodon-4.2 1 year ago
vendor d5bdfaf0bb Increase files checked by ESLint (#9705) 6 years ago
.browserslistrc 702b709d9a Add ES6 compatibility to browserslist (#18519) 2 years ago
.buildpacks 0ab97107c7 Remove nodejs buildpack from buildpacks (#14364) 4 years ago
.bundler-audit.yml 4eb98ef755 Ignore the devise-two-factor advisory as we have rate limits in place (#28733) 1 year ago
.dockerignore 211958e8b8 Update .dockerignore/.gitignore for #16947 etc (#17099) 3 years ago
.editorconfig c812cfa667 Enable EditorConfig trailing whitespace trimming (#23543) 2 years ago
.env.production.sample c649f4d386 fix: remove SMTP_SERVER (#21342) 2 years ago
.env.test 5605b828e5 Bump webpacker from 4.0.7 to 4.2.0 (#12416) 5 years ago
.env.vagrant b91724fb9d Add elastic search installation into Vagrantfile (#26512) 1 year ago
.eslintignore d5bdfaf0bb Increase files checked by ESLint (#9705) 6 years ago
.eslintrc.js a7253075d1 Upgrade to `typescript-eslint` v6 (#25904) 1 year ago
.foreman f5bf5ebb82 Replace sprockets/browserify with Webpack (#2617) 7 years ago
.gitattributes 7aeb9168b0 Add .gitattributes file to avoid unwanted CRLF (#3954) 7 years ago
.gitignore 64bea71714 helm: cleanup helm chart, now in mastodon/chart (#21801) 2 years ago
.haml-lint.yml 768b00c4d0 Consistently use middle dot (·) instead of bullet (•) to separate items (#25248) 1 year ago
.haml-lint_todo.yml a5842df123 Fix haml-lint Rubocop `Lint/UnusedBlockArguments` cop (#26039) 1 year ago
.nanoignore aa803153e2 Remove Storybook (#4397) 7 years ago
.nvmrc c6a535a197 Update dependency node to 20.7 (#26963) 1 year ago
.prettierignore b0780cfeed Fix `/share` and cleanup and reorganize frontend locale loading (#25240) 1 year ago
.prettierrc.js 51b83ed195 Use Prettier for ESLint formatting TypeScript (#23631) 1 year ago
.profile c0ea33e3fc Make it possible to upload audio and video to Heroku app (#24866) 1 year ago
.rspec 71fe24096c Adding a Mention model, test stubs 9 years ago
.rubocop.yml ad81be6c8e Update rubocop rules for linelength (#26190) 1 year ago
.rubocop_todo.yml 4c01f78480 Automatic rubocop fixing 1 year ago
.ruby-gemset f879cf03f0 Make Mastodon use its own gemset (#17858) 2 years ago
.ruby-version 7a22999f92 Bump ruby version to 3.2.3 1 year ago
.slugignore aa803153e2 Remove Storybook (#4397) 7 years ago
.yarnclean 34225d7199 Setup Husky and lint-stage for commit fixing (#23308) 1 year ago
AUTHORS.md 0fbefb6f67 Update AUTHORS.md (#27018) 1 year ago
Aptfile c0ea33e3fc Make it possible to upload audio and video to Heroku app (#24866) 1 year ago
CHANGELOG.md a5b4a2b7e7 Bump version to v4.2.10 (#30910) 8 months ago
CODE_OF_CONDUCT.md 0bfd9f7f73 Update Contributor Covenant to 2.1 (#23980) 1 year ago
CONTRIBUTING.md e594bb7d50 Convert CircleCI to GitHub Actions (#23608) 2 years ago
Capfile 717683d1c3 Autofix Rubocop remaining Layout rules (#23679) 2 years ago
Dockerfile 7a22999f92 Bump ruby version to 3.2.3 1 year ago
FEDERATION.md 4033d28160 Merge tag 'v4.2.0-rc1' into lets-bump-hometown-to-mastodon-4.2 1 year ago
Gemfile bfc287fd6b Remove dependency on posix-spawn (#18559) 8 months ago
Gemfile.lock 1e87634a43 Update dependency charlock_holmes 8 months ago
LICENSE d709151781 Fix #49 - License changed from GPL-2.0 to AGPL-3.0 8 years ago
Procfile 8630afb468 fix: make Procfile compatible with herokuish (#12685) 4 years ago
Procfile.dev 286a21afdc Support webpacker live-reloading on Docker (#26419) 1 year ago
README.md 510330fe6e Run formatting for markdown and SCSS 1 year ago
Rakefile f134a5f9d8 Run Rubocop on Rakefile (#23871) 1 year ago
SECURITY.md c5d56de98d Fix linting failure 1 year ago
Vagrantfile 4d9186a48c Add search tests (#26703) 1 year ago
app.json 9feba112a7 Make enable_starttls configurable by envvars (#20321) 2 years ago
babel.config.js ae2790d84f Update babel monorepo to v7.22.5 (#25405) 1 year ago
config.ru 717683d1c3 Autofix Rubocop remaining Layout rules (#23679) 2 years ago
crowdin.yml 626a7b6a77 Add a Github Action to send translations to Crowdin for each merge in main (#25869) 1 year ago
docker-compose.yml a5b4a2b7e7 Bump version to v4.2.10 (#30910) 8 months ago
ide-helper.js ee017ca533 Add JS IDE helper (#13012) 4 years ago
jest.config.js b0780cfeed Fix `/share` and cleanup and reorganize frontend locale loading (#25240) 1 year ago
jsconfig.json f77ed3a6b2 Correct prettier calls for YML/JSON (#21832) 2 years ago
package.json 5fd7cd79e0 Specify yarn version to avoid confusion with main which uses Yarn 4 8 months ago
postcss.config.js 15fdd94e2f Update PostCSS dependencies (#23835) 2 years ago
priv-config 905bd24788 TOR federation (#7875) 6 years ago
scalingo.json 93a84f4704 Add S3 region list reference to Scalingo config (#24152) 1 year ago
stylelint.config.js 2904fd0fdd Update Stylelint disable settings and ignores (#23776) 1 year ago
tsconfig.json 8f66126b10 Use the new JSX transform (#25064) 1 year ago
yarn.lock c74670b4d3 Update dependency glob to v10.3.5 (#27002) 1 year 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 tweet" debate for example.

Twitter has a feature called "quote tweeting" that lets you embed what someone else tweets, 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 can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository or submit translations using Crowdin. To get started, take a look at CONTRIBUTING.md. If your contributions are accepted into Mastodon, you can request to be paid through our OpenCollective.

IRC channel: #mastodon on irc.libera.chat

License

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

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

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/.