0ct0pu5
/
tutorials


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
							    <!DOCTYPE html>
    <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
      <head>
        <title>Run Mastodon - A Federated Twitter Alternative - in Docker</title>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
        <meta charset="UTF-8">
        <meta name="keywords" content="Browser Based,Docker Made Easy,Home Lab,Home Lab Ideas,Install Guide,Self-Hosted,Web Based,Web Based Tools,Alternative,Homelab,Linux,Micro Blogging,Microblogging,Social Media,Social Network,Twitter,Twitter Alternative,Mastodon,Federated,Container,Containerization,Docker,Docker How To,Docker Installation Tutorial,Docker Simplified,Docker Tutorial,Ubuntu,How To,Tutorial,i12bretro">
        <meta name="author" content="i12bretro">
        <meta name="description" content="Run Mastodon - A Federated Twitter Alternative - in Docker">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <meta name="revised" content="02/10/2023 02:00:52 PM" />
				          <link rel="icon" type="image/x-icon" href="includes/favicon.ico">
				  <script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js"></script>
				        <script type="text/javascript" src="includes/js/steps.js"></script>
        <link href="css/steps.css" rel="stylesheet" type="text/css" />
      </head>
      <body>
        <div id="gridContainer">
          <div class="topMargin"></div>
          <div id="listName" class="topMargin">
            <h1>Run Mastodon - A Federated Twitter Alternative - in Docker</h1>
          </div>
          <div></div>
          <div id="content">
          <h2>What is Mastodon?</h2>

<blockquote><em>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)! -<a href="https://github.com/mastodon/mastodon" target="_blank">https://github.com/mastodon/mastodon</a></em></blockquote>

<h2>Installing Docker</h2>

<ol>
	<li>Log into the Linux based device</li>
	<li>Run the following commands in the terminal
	<div class="codeBlock"># install prerequisites<br />
	sudo apt install apt-transport-https ca-certificates curl software-properties-common gnupg-agent -y<br />
	# add docker gpg key<br />
	curl -fsSL https://download.docker.com/linux/$(awk -F&#39;=&#39; &#39;/^ID=/{ print $NF }&#39; /etc/os-release)/gpg | sudo apt-key add -<br />
	# add docker software repository<br />
	sudo add-apt-repository &quot;deb [arch=$(dpkg --print-architecture)] https://download.docker.com/linux/$(awk -F&#39;=&#39; &#39;/^ID=/{ print $NF }&#39; /etc/os-release) $(lsb_release -cs) stable&quot;<br />
	# install docker<br />
	sudo apt install docker-ce docker-compose containerd.io -y<br />
	# enable and start docker service<br />
	sudo systemctl enable docker &amp;&amp; sudo systemctl start docker<br />
	# add the current user to the docker group<br />
	sudo usermod -aG docker $USER<br />
	# reauthenticate for the new group membership to take effect<br />
	su - $USER</div>
	</li>
</ol>

<h2>Generating SSL Certificate with Let&#39;s Encrypt</h2>

<p><em>NOTE: In order for Let&#39;s Encrypt to verify ownership of the DNS name, the host certbot is running from must be accessible via port 80 (http) or port 443 (https). For homelab users, this will normally involve port forwarding from the router to the certbot host, which is beyond the scope of this tutorial. Just note, I have forwarded port 80 on my router to the host running certbot for this handshake to complete successfully.</em></p>

<ol>
	<li>Continue with the following commands in a terminal window
	<div class="codeBlock"># remove apt version of certbot if installed<br />
	sudo apt remove certbot -y<br />
	# install snapd<br />
	sudo apt install snapd -y<br />
	# install snap core and update<br />
	sudo snap install core; sudo snap refresh core<br />
	# install certbot snap<br />
	sudo snap install --classic certbot<br />
	# create certbot symbolic link<br />
	sudo ln -s /snap/bin/certbot /usr/bin/certbot<br />
	# if a web server process is currently using port 80, stop it before proceeding<br />
	# generate a certificate<br />
	sudo certbot certonly --standalone --preferred-challenges http -d &lt;%DNS NAME%&gt;</div>
	</li>
	<li>When prompted, enter an email address and agree to the terms of service</li>
	<li>Choose whether to share your email and receive emails from certbot</li>
	<li>Certbot will output information regarding the location of the certificate files</li>
	<li>Continue with the following commands in a terminal window
	<div class="codeBlock"># create ssl-certs group<br />
	sudo groupadd ssl-certs<br />
	# add $USER and root users to group<br />
	sudo usermod -aG ssl-certs $USER<br />
	sudo usermod -aG ssl-certs root<br />
	# verify the members of ssl-cert<br />
	getent group ssl-certs<br />
	# set owner group of /etc/letsencrypt<br />
	sudo chgrp -R ssl-certs /etc/letsencrypt<br />
	# set permissions on /etc/letsencrypt<br />
	sudo chmod -R g=rX /etc/letsencrypt</div>
	</li>
</ol>

<h2>Running the Mastodon Container Stack</h2>

<ol>
	<li>Now that Docker is installed, run the following commands to setup the Mastodon Docker containers
	<div class="codeBlock"># create working directories<br />
	mkdir ~/docker/postgres -p &amp;&amp; mkdir ~/docker/redis -p &amp;&amp; mkdir ~/docker/mastodon/public/system -p &amp;&amp; mkdir ~/docker/nginx/conf -p<br />
	# pull the mastodon web container<br />
	docker pull tootsuite/mastodon<br />
	# generate secrets, run this 2 times<br />
	docker run --rm -it tootsuite/mastodon bundle exec rake secret<br />
	# generate VAPID keys<br />
	docker run --rm -it tootsuite/mastodon bundle exec rake mastodon:webpush:generate_vapid_key<br />
	# create a mastodon .env file<br />
	# copy the generated secrets and keys into the .env file<br />
	# make sure to set the LOCAL_DOMAIN as this cannot be changed later<br />
	nano ~/docker/mastodon/.env</div>
	</li>
	<li>Paste the following into the .env file, then edit the LOCAL_DOMAIN, WEB_DOMAIN, PostgreSQL, Secrets, Web Push and SMTP settings<br />
	<span style="font-size:12px;">NOTE: A full example .env file can be find at <a href="https://github.com/mastodon/mastodon/blob/main/.env.production.sample" style="font-size:12px;" target="_blank">https://github.com/mastodon/mastodon/blob/main/.env.production.sample</a></span>
	<p># This is a sample configuration file. You can generate your configuration<br />
	# with the `rake mastodon:setup` interactive setup wizard, but to customize<br />
	# your setup even further, you&#39;ll need to edit it manually. This sample does<br />
	# not demonstrate all available configuration options. Please look at<br />
	# https://docs.joinmastodon.org/admin/config/ for the full documentation.</p>

	<p># Note that this file accepts slightly different syntax depending on whether<br />
	# you are using `docker-compose` or not. In particular, if you use<br />
	# `docker-compose`, the value of each declared variable will be taken verbatim,<br />
	# including surrounding quotes.<br />
	# See: https://github.com/mastodon/mastodon/issues/16895</p>

	<p># Federation<br />
	# ----------<br />
	# This identifies your server and cannot be changed safely later<br />
	# ----------<br />
	LOCAL_DOMAIN=i12bretro.local</p>

	<p># ----------<br />
	# Optional, if different than LOCAL_DOMAIN<br />
	# ----------<br />
	#WEB_DOMAIN=toots.webredirect.org</p>

	<p># Redis<br />
	# -----<br />
	REDIS_HOST=redis<br />
	REDIS_PORT=6379</p>

	<p># PostgreSQL<br />
	# ----------<br />
	DB_HOST=postgres<br />
	DB_USER=mastodon_rw<br />
	DB_NAME=mastodon<br />
	DB_PASS=Ma5toD0n!<br />
	DB_PORT=5432</p>

	<p># Secrets<br />
	# -------<br />
	# Make sure to use `rake secret` to generate secrets<br />
	# -------<br />
	SECRET_KEY_BASE=<br />
	OTP_SECRET=</p>

	<p># Web Push<br />
	# --------<br />
	# Generate with `rake mastodon:webpush:generate_vapid_key`<br />
	# --------<br />
	VAPID_PRIVATE_KEY=<br />
	VAPID_PUBLIC_KEY=</p>

	<p># Sending mail<br />
	# ------------<br />
	SMTP_SERVER=smtp.example.com<br />
	SMTP_PORT=25<br />
	SMTP_LOGIN=<br />
	SMTP_PASSWORD=<br />
	SMTP_FROM_ADDRESS=mastodon@example.com</p>

	<p><br />
	# IP and session retention<br />
	# -----------------------<br />
	# Make sure to modify the scheduling of ip_cleanup_scheduler in config/sidekiq.yml<br />
	# to be less than daily if you lower IP_RETENTION_PERIOD below two days (172800).<br />
	# -----------------------<br />
	IP_RETENTION_PERIOD=31556952<br />
	SESSION_RETENTION_PERIOD=31556952</p>
	</li>
	<li>Press CTRL+O, Enter, CTRL+X to write the changes to .env</li>
	<li>Continue with the following steps in the terminal
	<div class="codeBlock"># set owner of docker directory<br />
	sudo chown &quot;$USER&quot;:&quot;$USER&quot; ~/docker -R<br />
	# create containers<br />
	docker network create containers<br />
	# run the postgesql container<br />
	docker run -d --name postgres -e POSTGRES_USER=mastodon_rw -e POSTGRES_PASSWORD=Ma5toD0n! -e POSTGRES_DB=mastodon -v ~/docker/postgres:/var/lib/postgresql/data --network containers --restart=unless-stopped postgres:latest<br />
	# run the redis container<br />
	docker run -d --name redis -v ~/docker/redis:/data --network containers --restart=unless-stopped redis<br />
	# initialize the mastodon database<br />
	docker run --rm -it --network containers --env-file ~/docker/mastodon/.env tootsuite/mastodon rails db:migrate<br />
	# run the mastodon frontend container<br />
	docker run -d --name mastodon --env-file ~/docker/mastodon/.env -p 3000:3000 -v ~/docker/mastodon/public/system:/mastodon/public/system --network containers --restart=unless-stopped tootsuite/mastodon bash -c &quot;rm -f /mastodon/tmp/pids/server.pid; bundle exec rails s -p 3000&quot;<br />
	# connect to shell inside mastodon container<br />
	docker exec -it mastodon /bin/bash<br />
	# set the RAILS_ENV variable<br />
	RAILS_ENV=production<br />
	# create an owner/admin account<br />
	# copy the password output for later<br />
	bin/tootctl accounts create &lt;%username%&gt; --email &lt;%email address%&gt; --confirmed --role Owner<br />
	# exit the container<br />
	exit<br />
	# run the mastodon streaming container<br />
	docker run -d --name mastodon-stream --env-file ~/docker/mastodon/.env -p 4000:4000 --network containers --restart=unless-stopped tootsuite/mastodon node ./streaming<br />
	# run the mastodon sidekiq container<br />
	docker run -d --name mastodon-sidekiq --env-file ~/docker/mastodon/.env --network containers -v ~/docker/mastodon/public/system:/mastodon/public/system --restart=unless-stopped tootsuite/mastodon bundle exec sidekiq</div>
	</li>
</ol>

<h2>Setting Up the Nginx Proxy Server</h2>

<ol>
	<li>Now that all the pieces of Mastodon are running, we&#39;ll configure an nginx proxy server
	<div class="codeBlock"># download the default mastodon nginx configuration<br />
	wget -O ~/docker/nginx/conf/mastodon.conf https://raw.githubusercontent.com/mastodon/mastodon/main/dist/nginx.conf<br />
	# replace some options to work running in docker containers<br />
	sed -i &quot;s/try_files \$uri =404;/try_files \$uri @proxy;/&quot; ~/docker/nginx/conf/mastodon.conf<br />
	# update the server_name with the URL being used to reach mastodon<br />
	# make sure to replace WEB_DOMAIN<br />
	sed -i &quot;s/server_name example.com;/\server_name &lt;%WEB_DOMAIN%&gt;;/&quot; ~/docker/nginx/conf/mastodon.conf<br />
	# update mastodon frontend server<br />
	sed -i &#39;s/server 127.0.0.1:3000/server mastodon:3000/&#39; ~/docker/nginx/conf/mastodon.conf<br />
	# update mastodon stream server<br />
	sed -i &#39;s/server 127.0.0.1:4000/server mastodon-stream:4000/&#39; ~/docker/nginx/conf/mastodon.conf<br />
	# update the ssl certificate path<br />
	# make sure to replace DNS NAME<br />
	sed -i &#39;s/# ssl_certificate\s*\/etc\/letsencrypt\/live\/example.com\/fullchain.pem;/ssl_certificate\t\/etc\/letsencrypt\/live\/&lt;%DNS NAME%&gt;\/fullchain.pem;/&#39; ~/docker/nginx/conf/mastodon.conf<br />
	# update the ssl key path<br />
	# make sure to replace DNS NAME<br />
	sed -i &#39;s/# ssl_certificate_key\s*\/etc\/letsencrypt\/live\/example.com\/privkey.pem;/ssl_certificate_key\t\/etc\/letsencrypt\/live\/&lt;%DNS NAME%&gt;\/privkey.pem;/&#39; ~/docker/nginx/conf/mastodon.conf<br />
	# create nginx proxy container<br />
	docker run --name nginx -p 80:80 -p 443:443 --network containers -v ~/docker/nginx/conf:/etc/nginx/conf.d:ro -v /etc/letsencrypt:/etc/letsencrypt:ro -d nginx</div>
	</li>
	<li>Open a web browser and navigate to https://&lt;%WEB_DOMAIN%&gt;</li>
	<li>Click Sign in then login using the owner email and generated password from earlier</li>
	<li>Select Preferences from the lower right of the user interface</li>
	<li>Select Account from the left navigation menu</li>
	<li>Enter the generated password in the Current password field, then enter and confirm a new password for the current user &gt; Click Save Changes</li>
	<li>Select Logout from the left navigation menu</li>
	<li>Log back in using the owner account email address and updated password</li>
	<li>Welcome to Mastodon</li>
</ol>          </div>
        </div>
      </body>
    </html>