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, and 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:
- Project homepage 🐘
- Support the development via Patreon
- View sponsors
- Blog
- Documentation
- Roadmap
- Official Docker image
- Browse Mastodon servers
- Browse Mastodon apps
It doesn't have to be Mastodon; whatever implements ActivityPub is part of the social network! Learn more
Updates of people you're following appear in real-time in the UI via WebSockets. There's a firehose view as well!
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!
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
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!
- 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
- PostgreSQL 9.5+
- Redis 4+
- Ruby 2.7+
- Node.js 16+
The repository includes deployment configurations for Docker and docker-compose as well as specific platforms like Heroku, Scalingo, and Nanobox. For Helm charts, reference the mastodon/chart repository. The standalone installation guide is available in the documentation.
https://learn.microsoft.com/en-us/windows/terminal/install
- Install Windows Subsystem for Linux (WSL) this will also install Ubuntu
wsl --install
- Setting WSL2 for your linux distros
wsl --set-default-version 2
Check the WSL version installed on Windows 10 or 11
wsl --list --verbose
NAME STATE VERSION
* docker-desktop-data Running 2
Ubuntu Running 2
docker-desktop Running 2
Ubuntu-20.04 Stopped 2
- Windows feature Windows Subsystem for Linux is turned off
Check if the Windows feature Windows Subsystem for Linux is turned off
Control panel ->
Program and Featrues ->
Turn Windows features on or off ->
Windows Subsystem for Linux (Check this box)
- CPU virtualization is disabled in BIOS
If you encounter this error when opening Power Shell or Ubuntu från Windows Terminal
Installing this may take a few minutes
WslRegisterDistrubution failed with error: 0x80370102
Please enable the Virtual Machine Platform Windows feature and ensure virtualization is enabled in the BIOS.
for information please visit https://aka.ms/enablevirtualization
Press any key to continue...
It means that the CPU virtualization is disabled in BIOS and must be enabled, follow tutorial link
https://www.bleepingcomputer.com/tutorials/how-to-enable-cpu-virtualization-in-your-computer-bios/
More information can be found here
https://aka.ms/enablevirtualization
- Open Ubuntu shell from Windows Terminal and create ssh keys
ssh-keygen -t rsa -b 2048
Generating public/private rsa key pair.
Enter file in which to save the key (/home/maw/.ssh/id_rsa):
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /home/maw/.ssh/id_rsa
Your public key has been saved in /home/maw/.ssh/id_rsa.pub
- The generated private/public keys are stored in home directory
maw@maw:/$ ls -l /home/maw/.ssh/
-rw------- 1 maw maw 3401 Oct 18 11:14 id_rsa
-rw-r--r-- 1 maw maw 756 Oct 18 11:14 id_rsa.pub
- Copy the content of public key id_rsa.pub to bitbucket
https://bitbucket.org/account/settings/ssh-keys/
/home/maw/projects
maw@maw:~/projects$ git clone [email protected]:softhouse/trust-social.git
https://docs.docker.com/desktop/install/windows-install/
- WSL 2 based engine
- WSL Integration
\\wsl$\Ubuntu\home\maw\projects\trust-social
- Install vscode Remote Development WSL extension
- Start trust-social project from WSL Ubuntu
code . # will install necessary software and start vscode on Windows
For development with Docker, complete the following steps:
-
Run to setup and start up the containers
docker compose -f .devcontainer/docker-compose.yml up -d
-
RunThis did not work follow belowdocker compose -f .devcontainer/docker-compose.yml exec app .devcontainer/post-create.sh
-
Finally, runThis did not work follow belowdocker compose -f .devcontainer/docker-compose.yml exec app foreman start -f Procfile.dev
-
You have to list running docker containers to get the proper service NAMES
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
/* */ devcontainer-es-1
/* */ devcontainer-redis-1
/* */ devcontainer-libretranslate-1
/* */ devcontainer-db-1
/* */ devcontainer-app-1
This is the service we are looking for devcontainer-app-1
- Log into your docker service
docker exec -it devcontainer-app-1 /bin/bash
- Inside the docker container
cd workspaces/trust-social/
- Run this command to setup the enviroment
.devcontainer/post-create.sh
- To start the all processes inside docker container
docker exec -it devcontainer-app-1 /bin/bash
- Inside the docker container
cd workspaces/trust-social/
- Run this command to start the application
foreman start -f Procfile.dev
- If the startup fails with errors
...
Unable to load application: SignalException: SIGTERM
terminated by SIGTERM
terminated by SIGTERM
- Run the Git dubious ownership suggestion
fatal: detected dubious ownership in repository at '/workspaces/trust-social'
To add an exception for this directory, call:
git config --global --add safe.directory /workspaces/trust-social
- Rerun the setup of the enviroment again
.devcontainer/post-create.sh
- Rerun the start up of the application
foreman start -f Procfile.dev
https://localhost:3000/letter_opener
- Start new containers or update existing ones based on your configuration
docker-compose up -d
- Stop and remove containers, networks, and volumes completely
docker-compose down
- Resume previously stopped containers
docker-compose start
- Temporarily stop containers without removing them
docker-compose stop
A Vagrant configuration is included for development purposes. To use it, complete the 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
https://mastodon.local
in your browser
To set up MacOS for native development, complete the following steps:
- Install the latest stable Ruby version (use a Ruby version manager for easy installation and management of Ruby versions)
- Run
brew install postgresql@14
- Run
brew install redis
- Run
brew install imagemagick
- Install Foreman or a similar tool (such as overmind) to handle multiple process launching.
- Navigate to Mastodon's root directory and run
brew install nvm
thennvm use
to use the version from .nvmrc - Run
corepack enable && yarn set version classic
- Run
bundle exec rails db:setup
(optionally prependRAILS_ENV=development
to target the dev environment) - Finally, run
overmind start -f Procfile.dev
If you are using an IDE with support for the Development Container specification, it will run the above docker compose
commands automatically. For Visual Studio Code this requires the Dev Container extension.
To get you coding in just a few minutes, GitHub Codespaces provides a web-based version of Visual Studio Code and a cloud-hosted development environment fully configured with the software needed for this project..
- Click this button to create a new codespace:
- Wait for the environment to build. This will take a few minutes.
- When the editor is ready, run
foreman start -f Procfile.dev
in the terminal. - After a few seconds, a popup will appear with a button labeled Open in Browser. This will open Mastodon.
- On the Ports tab, right click on the “stream” row and select Port visibility → Public.
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. If your contributions are accepted into Mastodon, you can request to be paid through our OpenCollective.
IRC channel: #mastodon on irc.libera.chat
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/.