README.md
<h1><picture>
<source media="(prefers-color-scheme: dark)" srcset="./lib/assets/wordmark-with-sub_forest.dark.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="./lib/assets/wordmark-with-sub_forest.light.png?raw=true">
<img alt="Mastodon" src="./lib/assets/wordmark.light.png?raw=true" height="34">
</picture></h1>
Mastodon fork for [littlefo.rest](https://littlefo.rest)
[](https://hub.docker.com/r/mashirozx/mastodon)
[](https://github.com/mashirozx/mastodon/actions/workflows/docker-build-main.yml)
[](https://github.com/mashirozx/mastodon/actions/workflows/docker-build-dev.yml)
[](https://drone.2heng.xin/mashirozx/mastodon)
[//]: # ([](https://deepsource.io/gh/mashirozx/mastodon/?ref=repository-badge))
[//]: # ([](https://circleci.com/gh/tootsuite/mastodon))
## Highlighted Features
- Custom toot max character size with environment variable (see `.env.production.sample`).
- Full Markdown support, demo [here](https://littlefo.rest/@mashiro/104670343090096501).
- Media Sudoku (media attachments upper limit increases to 9), demo [here](https://littlefo.rest/@mashiro/105426865955962437).
- Local-only toot support.
- Quotation support like twitter (QT but not RT).
- An easy-using translation button to translate toot in any language to your mother tongue with Google Translate, demo [here](https://s3.mashiro.top/mstdn/media_attachments/files/108/763/169/312/585/099/original/3735baafcfe154f3.png).
- A bunch of awesome themes.
- Enhanced Elasticsearch experience with Chinese words segmentation support (see specifications bellow).
- Login with GitHub and GitLab OAuth 2, try it now [here](https://littlefo.rest)!
## Specifications
### Version Control
This is a rebase fork of `tootsuite/mastodon`, all local changes are rebased on the top. To pull the latest commits of this repo, use `git reset --hard origin/main` instead of `git pull`. If you are going to develop based on this fork, I strongly recommend you always [cherry-pick](https://git-scm.com/docs/git-cherry-pick) your commits to the `HEAD` of this branch.
### Enable Custom Features
To enable the new custom features, please add the necessary configurations first according to the file end of `.env.production.sample`.
**This project added the Chinese words segmentation support in ElasticSearch, please use this [ElasticSearch image](https://github.com/mashirozx/elasticsearch-cnplugin). Using the original version of ElasticSearch Engine may goes into error.**
### Docker Images
The Docker images are listed [here](https://hub.docker.com/r/mashirozx/mastodon/tags).
<table>
<tr>
<td>Tag</td>
<td>Architecture</td>
<td>Remarks</td>
</tr>
<tr>
<td><code>latest</code></td>
<td>amd64/arm64</td>
<td rowspan=3>The latest image build from <code>main</code> branch (<strong>unstable sometimes</strong>).</td>
</tr>
<tr>
<td><code>latest-arm64</code></td>
<td>arm64</td>
</tr>
<tr>
<td><code>latest-amd64</code></td>
<td>amd64</td>
</tr>
<tr>
<td><code>sha-*</code></td>
<td>amd64/arm64</td>
<td rowspan=3>The image build from commit with the specified SHA (<strong>unstable</strong>).</td>
</tr>
<tr>
<td><code>sha-*-arm64</code></td>
<td>arm64</td>
</tr>
<tr>
<td><code>sha-*-amd64</code></td>
<td>amd64</td>
</tr>
<tr>
<td><code>YY.MM.DD</code></td>
<td>amd64/arm64</td>
<td rowspan=3>The image build from release. Normally a release was made every time rebase merging upstream code (<strong>stable</strong>).</td>
</tr>
<tr>
<td><code>YY.MM.DD-arm64</code></td>
<td>arm64</td>
</tr>
<tr>
<td><code>YY.MM.DD-amd64</code></td>
<td>amd64</td>
</tr>
</table>
## Some Notes and Further Plan
Since there are a lot of changes in v4 of upstream, I'm still working on merging it, see `dev` branch. But for the benefit of a long turn maintenance, I'm planing remove some less important features form this fork to reduce the work I have to do every time when merge the code. I'm also considering switching to another web front end, like [elk](https://elk.zone), because the official web interface is really not in my favour :(
I see there is [a pull request](https://github.com/mastodon/mastodon/pull/16210) on upstream that contains changes to use TypeScript, which is great, I'll keep an eye on it.
## Finally
Thanks for the support of [JetBrains](https://jb.gg/OpenSourceSupport).
[<img width="100" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg" alt="JetBrains Logo (Main) logo.">](https://jb.gg/OpenSourceSupport)
***
*Follows the original README*
***
<h1><picture>
<source media="(prefers-color-scheme: dark)" srcset="./lib/assets/wordmark.dark.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="./lib/assets/wordmark.light.png?raw=true">
<img alt="Mastodon" src="./lib/assets/wordmark.light.png?raw=true" height="34">
</picture></h1>
[][releases]
[][circleci]
[][code_climate]
[][crowdin]
[][docker]
[releases]: https://github.com/mastodon/mastodon/releases
[circleci]: https://circleci.com/gh/mastodon/mastodon
[code_climate]: https://codeclimate.com/github/mastodon/mastodon
[crowdin]: https://crowdin.com/project/mastodon
[docker]: https://hub.docker.com/r/tootsuite/mastodon/
Mastodon is a **free, open-source social network server** based on ActivityPub where users can follow friends and discover new ones. On Mastodon, users can publish anything they want: links, pictures, text, video. All Mastodon servers are interoperable as a federated network (users on one server can seamlessly communicate with users from another one, including non-Mastodon software that implements ActivityPub)!
Click below to **learn more** in a video:
[][youtube_demo]
[youtube_demo]: https://www.youtube.com/watch?v=IPSbNdBmWKE
## Navigation
- [Project homepage 🐘](https://joinmastodon.org)
- [Support the development via Patreon][patreon]
- [View sponsors](https://joinmastodon.org/sponsors)
- [Blog](https://blog.joinmastodon.org)
- [Documentation](https://docs.joinmastodon.org)
- [Browse Mastodon servers](https://joinmastodon.org/communities)
- [Browse Mastodon apps](https://joinmastodon.org/apps)
[patreon]: https://www.patreon.com/mastodon
## Features
<img src="/app/javascript/images/elephant_ui_working.svg?raw=true" align="right" width="30%" />
### No vendor lock-in: Fully interoperable with any conforming platform
It doesn't have to be Mastodon; whatever implements ActivityPub is part of the social network! [Learn more](https://blog.joinmastodon.org/2018/06/why-activitypub-is-the-future/)
### Real-time, chronological timeline updates
Updates of people you're following appear in real-time in the UI via WebSockets. There's a firehose view as well!
### Media attachments like images and short videos
Upload and view images and WebM/MP4 videos attached to the updates. Videos with no audio track are treated like GIFs; normal videos loop continuously!
### Safety and moderation tools
Mastodon includes private posts, locked accounts, phrase filtering, muting, blocking and all sorts of other features, along with a reporting and moderation system. [Learn more](https://blog.joinmastodon.org/2018/07/cage-the-mastodon/)
### OAuth2 and a straightforward REST API
Mastodon acts as an OAuth2 provider, so 3rd party apps can use the REST and Streaming APIs. This results in a rich app ecosystem with a lot of choices!
## Deployment
### Tech stack:
- **Ruby on Rails** powers the REST API and other web pages
- **React.js** and Redux are used for the dynamic parts of the interface
- **Node.js** powers the streaming API
### Requirements:
- **PostgreSQL** 9.5+
- **Redis** 4+
- **Ruby** 2.6+
- **Node.js** 14+
The repository includes deployment configurations for **Docker and docker-compose** as well as specific platforms like **Heroku**, **Scalingo**, and **Nanobox**. The [**standalone** installation guide](https://docs.joinmastodon.org/admin/install/) is available in the documentation.
A **Vagrant** configuration is included for development purposes. To use it, complete following steps:
- Install Vagrant and Virtualbox
- Install the `vagrant-hostsupdater` plugin: `vagrant plugin install vagrant-hostsupdater`
- Run `vagrant up`
- Run `vagrant ssh -c "cd /vagrant && foreman start"`
- Open `http://mastodon.local` in your browser
## Contributing
Mastodon is **free, open-source software** licensed under **AGPLv3**.
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](CONTRIBUTING.md). If your contributions are accepted into Mastodon, you can request to be paid through [our OpenCollective](https://opencollective.com/mastodon).
**IRC channel**: #mastodon on irc.libera.chat
## License
Copyright (C) 2016-2022 Eugen Rochko & other Mastodon contributors (see [AUTHORS.md](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/>.