A supported fork of Mastodon that provides local posting and a wider range of content types.
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.
 
 
 
 
 
Darius Kazemi 9b1122036d Removing stray scrollbars in smaller windows 4 months ago
.circleci Removing stray scrollbars in smaller windows 4 months ago
.github Removing stray scrollbars in smaller windows 4 months ago
app Removing stray scrollbars in smaller windows 4 months ago
bin Removing stray scrollbars in smaller windows 4 months ago
chart helm: upgrade elasticsearch chart to 14 (#15767) 7 months ago
config Merge tag 'v3.4.0' into hometown-dev 4 months ago
db Merge tag 'v3.4.0' into hometown-dev 4 months ago
dist templates/systemd/mastodon: optimize SystemCallFilters (#16127) 5 months ago
lib Merge tag 'v3.4.0' into hometown-dev 4 months ago
log Initial commit 6 years ago
nanobox Resync Nanobox files with the 2.9.0 release (#11083) 2 years ago
public Merge tag 'v3.4.0' into hometown-dev 4 months ago
spec Merge tag 'v3.4.0' into hometown-dev 4 months ago
streaming Merge tag 'v3.4.0' into hometown-dev 4 months ago
vendor Increase files checked by ESLint (#9705) 3 years ago
.buildpacks Remove nodejs buildpack from buildpacks (#14364) 1 year ago
.codeclimate.yml Bump rubocop from 1.8.1 to 1.9.1 (#15677) 8 months ago
.deepsource.toml Update .deepsource.toml (#15753) 7 months ago
.dockerignore dockerignore helm chart (#15747) 7 months ago
.editorconfig Dev Tooling fixes (eslint/editorconfig) (#1398) 5 years ago
.env.nanobox Fix sample SAML_ACS_URL, SAML_ISSUER (#12669) 2 years ago
.env.production.sample Fix the wrong full documentation link (#14293) 1 year ago
.env.test Bump webpacker from 4.0.7 to 4.2.0 (#12416) 2 years ago
.env.vagrant Add a default DB_HOST to .env.vagrant for enable the streaming (#14030) 1 year ago
.eslintignore Increase files checked by ESLint (#9705) 3 years ago
.eslintrc.js Enable promise/catch-or-return allowFinally (#14289) 1 year ago
.foreman Replace sprockets/browserify with Webpack (#2617) 4 years ago
.gitattributes Add .gitattributes file to avoid unwanted CRLF (#3954) 4 years ago
.gitignore helm: pin versions, commit lockfile (#15749) 7 months ago
.haml-lint.yml Added haml-lint and fix warnings (#2773) 4 years ago
.nanoignore Remove Storybook (#4397) 4 years ago
.nvmrc Upgrade .nvmrc to Node.js 12 (#12906) 2 years ago
.profile Add ffmpeg and dependent packages as well as LD_LIBRARY_PATHs (#3276) 4 years ago
.rspec Adding a Mention model, test stubs 6 years ago
.rubocop.yml Fix rubocop config and warnings (#15503) 9 months ago
.ruby-version Use Ruby 2.7.2 (#15150) 10 months ago
.sass-lint.yml Fix sass-lint config (#10982) 2 years ago
.slugignore Remove Storybook (#4397) 4 years ago
.yarnclean Replace from scss-lint to sass-lint (#10958) 2 years ago
AUTHORS.md Bump version to 3.4.0 (#16239) 4 months ago
Aptfile Use libvpx >= 5 (#15591) 8 months ago
CHANGELOG.md Bump version to 3.4.0 (#16239) 4 months ago
CODE_OF_CONDUCT.md Add code of conduct from GitHub generator (#5674) 4 years ago
CONTRIBUTING.md Add pull request title recommendations to CONTRIBUTING.md (#16247) 4 months ago
Capfile remove capistrano/faster_assets from Capfile (#2737) 4 years ago
Dockerfile build: install shared-mime-info in Dockerfile (#15978) 6 months ago
Gemfile Bump rubocop from 1.13.0 to 1.14.0 (#16192) 5 months ago
Gemfile.lock Merge tag 'v3.4.0' into hometown-dev 4 months ago
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 5 years ago
Procfile fix: make Procfile compatible with herokuish (#12685) 1 year ago
Procfile.dev Set RAILS_ENV in Procfile.dev (#15502) 9 months ago
README.md Merge tag 'v3.4.0' into hometown-dev 4 months ago
Rakefile Initial commit 6 years ago
SECURITY.md Fix security policy (#16248) 4 months ago
Vagrantfile updated node version in Vagrantfile (#16230) 5 months ago
app.json Stop using heroku-buildpack-nodejs (#14341) 1 year ago
babel.config.js Remove dependency for @babel/plugin-proposal-class-properties (#16155) 5 months ago
boxfile.yml Fix to isolate the sidekiq process that runs the scheduler job (#15314) 10 months ago
config.ru Fix rubocop issues, introduce usage of frozen literal to improve performance 5 years ago
crowdin.yml Update Crowdin configuration file 2 years ago
docker-compose.yml Update Elasticsearch from 6.1 to 6.8 in docker-compose.yml (Fix glitch-soc#1348) (#14016) 1 year ago
ide-helper.js Add JS IDE helper (#13012) 1 year ago
package.json Bump glob from 7.1.6 to 7.1.7 (#16204) 5 months ago
postcss.config.js Increase files checked by ESLint (#9705) 3 years ago
priv-config TOR federation (#7875) 3 years ago
scalingo.json Remove deprecated config from Heroku and Scalingo (#11925) 2 years ago
yarn.lock Bump glob from 7.1.6 to 7.1.7 (#16204) 5 months 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. This fork is based on the principle of: minimum code change for maximum user experience change. 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 Thibaut 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.

But it's also open to abuse with people quote-tweeting things they disagree with to encourage a pile-on from their followers. There's been a lot of debate among Mastodon users as to whether the good of this feature outweighs the bad. So far, Mastodon has avoided implementing quoting.

What does this have to do with content types? Well, if we support an Article content type and a Note content type, we can support quoting for an Article but not for a Note. In practice this means that you can quote blog posts and news articles, but you can't quote a quick personal microblog note.

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.

License

Copyright (C) 2016-2021 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/.