...
BIN
tosort/tf_mastodon/img/getmastodon_advance.png
Normal file
After Width: | Height: | Size: 179 KiB |
BIN
tosort/tf_mastodon/img/getmastodon_basic.png
Normal file
After Width: | Height: | Size: 636 KiB |
BIN
tosort/tf_mastodon/img/getmastodon_credentials_mnemonics.png
Normal file
After Width: | Height: | Size: 342 KiB |
BIN
tosort/tf_mastodon/img/getmastodon_credentials_ssh.png
Normal file
After Width: | Height: | Size: 199 KiB |
BIN
tosort/tf_mastodon/img/getmastodon_details.png
Normal file
After Width: | Height: | Size: 488 KiB |
BIN
tosort/tf_mastodon/img/getmastodon_done.png
Normal file
After Width: | Height: | Size: 1.2 MiB |
BIN
tosort/tf_mastodon/img/getmastodon_list.png
Normal file
After Width: | Height: | Size: 702 KiB |
BIN
tosort/tf_mastodon/img/getmastodon_payqr.png
Normal file
After Width: | Height: | Size: 380 KiB |
BIN
tosort/tf_mastodon/img/getmastodon_relogin.png
Normal file
After Width: | Height: | Size: 1.1 MiB |
BIN
tosort/tf_mastodon/img/getmastodon_setup.png
Normal file
After Width: | Height: | Size: 112 KiB |
BIN
tosort/tf_mastodon/img/getmastodon_start.jpeg
Normal file
After Width: | Height: | Size: 129 KiB |
BIN
tosort/tf_mastodon/img/getmastodon_start.jpg
Normal file
After Width: | Height: | Size: 129 KiB |
BIN
tosort/tf_mastodon/img/getmastodon_success.png
Normal file
After Width: | Height: | Size: 3.1 MiB |
BIN
tosort/tf_mastodon/img/getmastodon_tf.png
Normal file
After Width: | Height: | Size: 176 KiB |
BIN
tosort/tf_mastodon/img/manual__getmastodon_tf.png
Normal file
After Width: | Height: | Size: 176 KiB |
151
tosort/tf_mastodon/tf_mastodon_deploy.md
Normal file
@@ -0,0 +1,151 @@
|
||||
# Deploy a Mastodon Server
|
||||
|
||||

|
||||
|
||||
On this tutorial you will learn on how to deploy a Mastodon Server using [https://getmastodon.threefold.io/](https://getmastodon.threefold.io/).
|
||||
|
||||
ThreeFold has made it possible for everyone to run their own Mastodon Instance, simply and effectively. Feel free to go to [www.mastodon.threefold.io](https://www.mastodon.threefold.io/) to read about ThreeFold's Mastodon Servers
|
||||
|
||||
## What is Mastodon
|
||||
|
||||
[Mastodon](https://joinmastodon.org/) is free and `open-source` software for running self-hosted social networking services. It has microblogging features similar to the Twitter service, which are offered by a large number of independently run nodes, known as `instances`, each with its own code of conduct, terms of service, privacy options, and moderation policies.
|
||||
|
||||
Each user is a member of a specific `Mastodon` instance `also called a server`, which can interoperate as a federated social network, allowing users on different instance to interact with each other. This is intended to give users the flexibility to select a node whose policies they prefer, but keep access to a larger social network. `Mastodon` is also part of the Fediverse ensemble of server platforms, which use shared protocols allowing users to also interact with users on other compatible platforms,[9] such as [PeerTube](../weblets/weblets_peertube.md).
|
||||
`Mastodon` is crowdfunded and does not contain ads.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- TFT Wallet (TFTs are needed to fund the deployment), we recommend you to use **TF Connect App** [Android](https://play.google.com/store/apps/details?id=org.jimber.threebotlogin&hl=en&gl=US&pli=1) / [Apple](https://apps.apple.com/us/app/threefold-connect/id1459845885)
|
||||
|
||||
Please download TF Connect App before you proceed.
|
||||
|
||||
## Get Started
|
||||
|
||||
- Go to [https://getmastodon.threefold.io/](https://getmastodon.threefold.io/) to begin the deployment journey.
|
||||
|
||||
## Set Up New Account Credentials
|
||||
|
||||
At the deployment homepage, you will be presented on **'Credentials'** page
|
||||
|
||||

|
||||
|
||||
### Create an account by generating a Mnemonics
|
||||
- **Mnemonics**: The login key to your Mastodon deployment (just like a password).
|
||||
|
||||
If this is your first deployment, simply Click **'Create Account'** and the system will automatically generate random phrases that serve as your mnemonics.
|
||||
|
||||

|
||||
|
||||
**Please keep a copy of your mnemonics safe.** This would be the only way to recover your instance in the future. Failure to do so will result in a loss of account.
|
||||
|
||||
If you have created a deployment account via [https://getmastodon.threefold.io/](https://getmastodon.threefold.io/) before, simply copy and paste your existing mnemonics to deploy a new instance, and the system will automatically log you in, and displaying your existing deployment (if any).
|
||||
|
||||
### Top up Account Wallet
|
||||
|
||||
Now that you have successfully created your login key, you will need to top up the account by using a TFT Wallet. You need to first fund the account to continue to the next step because the blockchain would need some TFT to fund an account creation.
|
||||
|
||||
Simply scan the QR Code shown to transfer TFT from your TFT wallet to your deployment account. We recommend you to transfer min. 20 TFT to begin with. You can recharge your account anytime.
|
||||
|
||||

|
||||
|
||||
It may takes a few minutes until the transfer is successful. We would recommend that you keep your windows open, otherwise you would need to re-login again by using your mnemonic keys. If you accidentally closed your window, you will not have to worry as the transfer will still proceed and you can simply re-login again.
|
||||
|
||||
### Generate your SSH Keys
|
||||
|
||||
After you have successfully transferred some TFT, you will be asked to generate SSH Keys (for new accounts only) by clicking **‘Generate’** button on the right side. This key is used to authenticate and establish an encrypted communication channel to your Mastodon.
|
||||
|
||||

|
||||
|
||||
If you have previously generated SSH keys on existing profile, you may skip this step.
|
||||
Once you have done all the steps above, we can move on to setup your first Mastodon server by clicking either the 'Basic' or 'Advance' setup options.
|
||||
|
||||

|
||||
|
||||
|
||||
## Setting up Your Mastodon Server
|
||||
|
||||
- **Basic** Setup: Mastodon Server deployment setting with pre-configured deployment setup (capacity and network configurations)
|
||||
- **Advance** Setup: Mastodon Server deployment setting for users who prefer to choose their own deployment configuration (capacity and network configurations). For this you still need to configure some variables like admin email and deployment name before configuring the advance setup.
|
||||
|
||||
## Basic Setup
|
||||
|
||||

|
||||
|
||||
Basic Mastodon Server Setup consists of:
|
||||
- Mastodon instance name: This will be used to identify your deployment, as well as your Mastodon Server subdomain. Please add a name to your new server.
|
||||
- Admin Email: Please add an email used as the server's administrator's email.
|
||||
- Region: Please choose the preferred region for new Mastodon server.
|
||||
- Enable TF Connect: You can choose of whether you'd like an extra step for your server users to login using TFConnect App or not.
|
||||
- Certified: You can choose of whether you'd like to deploy your server using Threefold certified 3Node or DIY node farms. Certified nodes are nodes that farmers bought from ThreeFold Certified Nodes partners.
|
||||
|
||||
If you choose to only do basic setup, you don't need to configure the advance setup. Once you have filled the forms above, simply click **'Deploy'** and you will be notified when your deployment is successful!
|
||||
|
||||

|
||||
|
||||
Please keep in mind that **you need to have sufficient amount of TFTs** in your deployment wallet in order your deployment to be successful.
|
||||
|
||||
Upon a successful server deployment, you will need to also have sufficient TFTs to keep your deploy alive. Failure to do so will result in server deactivation (not deletion), and You will be given 2 weeks of grace period time to top up your account to reactivate your servers. [Click here for more detailed information about Grace Period.](../concepts/contract_grace_period.md).
|
||||
|
||||
To top up your wallet, simply go back to **'Credentials'** and transfer TFTs to your account.
|
||||
|
||||
## Advance Setup
|
||||
|
||||

|
||||
|
||||
Before configuring the advance setup please keep in mind that you would need to configure the **basic setup** (see Basic Setup section on this page above) too.
|
||||
|
||||
Advance Mastodon Server Setup consists of:
|
||||
- CPU: Choose the total number of CPU resource for your Mastodon Server
|
||||
- Disk (Gb): Choose the total size of Disk (Storage) resource for your Mastodon Server
|
||||
- IP (Internet Protocol): Choose the Internet Protocol Mode for your Mastodon Server. You can either choose to deploy your server on ThreeFold's Planetary Network, a IPv4 or IPv6. Learn about the differences [here](https://www.geeksforgeeks.org/differences-between-ipv4-and-ipv6/).
|
||||
- Web Gateway: You can choose a specific node farm for your Mastodon Server
|
||||
- Node Farm: Select a specific node farm for your Mastodon Server
|
||||
- Node ID: Deploy your Mastodon Instance using a specific Node
|
||||
- Admin Username: Create a username for you Mastodon Server
|
||||
- Password: Create password for you Mastodon Server
|
||||
|
||||
Once you have filled the forms above, simply click **'Deploy'** and you will be notified when your deployment is successful!
|
||||
|
||||

|
||||
|
||||
Please keep in mind that **you need to have sufficient amount of TFTs** in your deployment wallet in order your deployment to be successful.
|
||||
To top up your wallet, simply go back to **'Credentials'** tab and transfer TFTs to your account.
|
||||
|
||||
|
||||
## Manage Your Deployment Account and Server(s)
|
||||
|
||||
### Managing Servers
|
||||
|
||||
After you successfully deployed a mastodon server, you can simply manage your deployment on the **'Deployment List (Mastodon)'** section at the bottom of the page inside your account. This page shows all the servers you have deployed via [https://getmastodon.threefold.io/
|
||||
](https://getmastodon.threefold.io/) including the billing rate and all the deployment details.
|
||||
|
||||

|
||||
|
||||
- Show Details: You can see the details of your deployment, such as admin username, password, email, and all the complete list of the server configuration.
|
||||
|
||||

|
||||
|
||||
- Open: is a link to your Mastodon Server.
|
||||
- Delete: delete your Mastodon Server.
|
||||
|
||||
### Accessing your Mastodon Server
|
||||
|
||||
Simply click 'Open' on one of your server in the list to go to your Mastodon Server.
|
||||
|
||||

|
||||
|
||||
## Accessing (Re-login) to Your (existing) Account
|
||||
|
||||
Once you have successfully created an account and deployed your Mastodon server, to regain access to your deployment account manage your active Mastodon Servers or to create a new one, simply go to [https://getmastodon.threefold.io/](https://getmastodon.threefold.io/)
|
||||
and **copy paste your existing Account Mnemonics**. You will be automatically logged into your account once you have done so.
|
||||
|
||||
Once you're logged in, you will also be shown how much TFT Balance left you have in your account, as well as the list of Mastodon Servers you currently have.
|
||||
|
||||

|
||||
|
||||
## Conclusion
|
||||
|
||||
Deploying [Mastodon](https://www.mastodon.threefold.io/) have never been easier. ThreeFold has made it possible for everyone to deploy and run their own Mastodon Server, simply and effectively. Let’s get started and happy experimenting!
|
||||
|
||||
> Read the FAQ on Mastodon Servers Powered by ThreeFold [here](./tf_mastodon_faq.md).
|
||||
|
31
tosort/tf_mastodon/tf_mastodon_faq.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Mastodon FAQ
|
||||
|
||||
- **What do I need to get started?**
|
||||
You only need a TFT wallet and some TFTs to get started. TFTs are needed to fund the deployment. We recommend you to use **TF Connect App** [Android](https://play.google.com/store/apps/details?id=org.jimber.threebotlogin&hl=en&gl=US&pli=1) / [Apple](https://apps.apple.com/us/app/threefold-connect/id1459845885). Please download TF Connect App before you proceed.
|
||||
|
||||
- **How can I buy TFTs?**
|
||||
You can buy TFTs in numerous ways, for example via decentralized exchangers, farmers, and many more. Read the complete list of TFT vendors and how to buy TFT [**here**](../concepts/buying_storing_tft.md).
|
||||
|
||||
- **What happens if I forget my Mnenomic?**
|
||||
Unfortunately, since our deployment account system is truly decentralized, we would not be able to assist you to log into your account without Mnemonic. **Please keep a copy of your mnemonic safe.** This would be the only way to recover your instance in the future. Failure to do so will result in a loss of account.
|
||||
|
||||
- **Can I deploy multiple Mastodon servers on the same deployment account?**
|
||||
Yes, you can! You can manage all your mastodon servers on the 'Deployment List' section of your account.
|
||||
|
||||
- **What's The difference for me as a user to build a mastodon server on certified node vs DIY node?**
|
||||
Building Mastodon Servers using Certified Nodes mean that you are building your server on top of ThreeFold's nodes that farmers bought from ThreeFold Certified Nodes partners, instead of DIY Nodes (Nodes that farmers build themselves).
|
||||
|
||||
- - **What does exactly 'Enable TF Connect' on the 'basic'deployment setting mean?**
|
||||
In means once you have activated your Mastodon servers, you have the option of letting users of your server to create or login to their Mastodon account quickly by using TF Connect App login.
|
||||
|
||||
- **What does exactly 'locked balance' on my account mean?**
|
||||
Locked Balance means the balance, or the amount of topped up TFT in your deployment wallet that has already been reserved and allocated for your active deployed servers. Each server that you have deployed and activated will need to be funded daily, and the locked balance make sure that your server will be up and running.
|
||||
|
||||
- **What happens if I forgot to fund my mastodon server?**
|
||||
If your account is running out of balance, your mastodon server will be temporarily deactivated until you top up your account again, the server will not be deleted. You will be given a grace period of two weeks to top up your balance and reactivate your server. [Click here for more detailed information about Grace Period.](../concepts/contract_grace_period.md)
|
||||
|
||||
- **How will I know if my account is running out of balance?**
|
||||
Your deployment wallet will always display how much TFT is left on your account.
|
||||
|
||||
- **I accidentally deleted my Mastodon Server, can I get it back?**
|
||||
Unfortunately once deleted, you won't be able to retract your old server back. That is why we always ask you to confirm upon server deletion everytime.
|
24
tosort/tf_mastodon/tf_mastodon_readme.md
Normal file
@@ -0,0 +1,24 @@
|
||||
<h1> ThreeFold Mastodon Deployer Manual </h1>
|
||||
|
||||

|
||||
|
||||
This comprehensive guide provides step-by-step instructions on deploying Mastodon, a popular decentralized social media platform via [ThreeFold's Mastodon Deployer](https://getmastodon.threefold.io/).
|
||||
|
||||
Not to be confused with ThreeFold's Mastodon Weblet. This is not a weblet tutorial.
|
||||
|
||||
This guide aims to answer common questions and provide a user-friendly resource for setting up and configuring Mastodon using the ThreeFold technology.
|
||||
|
||||
Whether you're new to Mastodon or an experienced user, this manual will assist you in effortlessly deploying and managing your Mastodon instance.
|
||||
|
||||
To explore further resources and information, visit the following links:
|
||||
|
||||
* [ThreeFold Mastodon Website](https://mastodon.threefold.io)
|
||||
* [ThreeFold Mastodon Deployer](https://getmastodon.threefold.io/)
|
||||
|
||||
Get ready to create your own decentralized social media presence with ThreeFold Mastodon Deployer!
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Mastodon Deployer Manual](./tf_mastodon_deploy.md)
|
||||
- [Mastodon FAQ](./tf_mastodon_faq.md)
|
||||
|