ourworld_web/docs_projectmycelium
23
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
docs_projectmycelium/docs/network/quick-start.md

6.2 KiB
Raw Permalink Blame History

sidebar_position
sidebar_position
3

Quick Start

Get connected to the Mycelium network in under 5 minutes.

Using the Mycelium App (Easy)

If you're on iOS, Android, macOS, or Windows – use the app for the easiest experience.

Step 1: Open the App

  1. Open the Mycelium app you installed.
  2. You'll see a simple interface with a Start button.

Step 2: Start Mycelium

  1. Click the Start button.
  2. The app will automatically connect to the network.
  3. That's it – you're now on the Mycelium network.

:::tip That's It The app handles everything automatically. No configuration needed. :::

Step 3: Get Your Mycelium Address

Your unique Mycelium IPv6 address is shown in the app:

  1. Look for your address on the main screen.
  2. Click the copy button next to it to copy your address.
  3. Share this address with others to let them connect to you.

Step 4: Add More Peers (Optional)

For better connectivity, you can add public peers:

  1. Click on the Peers section in the app.
  2. Add peer addresses (see list below).
  3. Click Restart to connect to the new peers.

Example peers to add:

tcp://188.40.132.242:9651
tcp://185.69.166.8:9651
tcp://65.21.231.58:9651

Step 5: Test Your Connection

Try connecting to another Mycelium address to verify everything works.

Using Command-Line (Linux & Advanced Users)

For Linux users or those who prefer the command-line.

Step 1: Start Mycelium

sudo mycelium --peers tcp://188.40.132.242:9651 quic://185.69.166.8:9651

You should see output indicating Mycelium is starting and connecting to peers.

Step 2: Get Your IPv6 Address

Open a new terminal and check your node info:

mycelium inspect --json

Example output:

{
  "publicKey": "abd16194646defe7ad2318a0f0a69eb2e3fe939c3b0b51cf0bb88bb8028ecd1d",
  "address": "5c4:c176:bf44:b2ab:5e7e:f6a:b7e2:11ca"
}

Save your address – this is your unique Mycelium IPv6 address.

Step 3: Test Connectivity

Ping one of the public peers to verify connectivity:

ping6 54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907

If you see responses, you're connected.

Step 4: Keep It Running (Linux)

Run in Background:

# Using nohup
nohup sudo mycelium --peers tcp://188.40.132.242:9651 quic://185.69.166.8:9651 &

Better: Use systemd:

Create /etc/systemd/system/mycelium.service:

[Unit]
Description=Mycelium Network
After=network.target

[Service]
Type=simple
ExecStart=/usr/local/bin/mycelium --peers tcp://188.40.132.242:9651 quic://185.69.166.8:9651
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target

Enable and start:

sudo systemctl enable mycelium
sudo systemctl start mycelium
sudo systemctl status mycelium

Public Peers List

Here are stable public peers you can connect to:

Region Address for App Mycelium IP
Germany tcp://188.40.132.242:9651 54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907
Germany tcp://136.243.47.186:9651 40a:152c:b85b:9646:5b71:d03a:eb27:2462
Belgium tcp://185.69.166.7:9651 597:a4ef:806:b09:6650:cbbf:1b68:cc94
Belgium tcp://185.69.166.8:9651 549:8bce:fa45:e001:cbf8:f2e2:2da6:a67c
Finland tcp://65.21.231.58:9651 410:2778:53bf:6f41:af28:1b60:d7c0:707a
Finland tcp://65.109.18.113:9651 488:74ac:8a31:277b:9683:c8e:e14f:79a7
US East tcp://209.159.146.190:9651 4ab:a385:5a4e:ef8f:92e0:1605:7cb6:24b2
US West tcp://5.78.122.16:9651 4de:b695:3859:8234:d04c:5de6:8097:c27c
Singapore tcp://5.223.43.251:9651 5eb:c711:f9ab:eb24:ff26:e392:a115:1c0e
India tcp://142.93.217.194:9651 445:465:fe81:1e2b:5420:a029:6b0:9f61

Using the App? Just copy these addresses and paste them into the Peers section.

Using Command-Line? Add multiple peers for better reliability:

sudo mycelium --peers \
  tcp://188.40.132.242:9651 \
  tcp://185.69.166.8:9651 \
  tcp://185.69.166.7:9651 \
  tcp://65.21.231.58:9651

What You Can Do Now

SSH to Another Device

If you have SSH running on another device with Mycelium:

ssh user@5c4:c176:bf44:b2ab:5e7e:f6a:b7e2:11ca

Access a Web Service

curl http://[5c4:c176:bf44:b2ab:5e7e:f6a:b7e2:11ca]:8080

Note: IPv6 addresses must be in brackets for URLs.

Connect Multiple Devices

Run Mycelium on devices at different locations:

  • They automatically find each other through the mesh.
  • Use their Mycelium IPs to communicate.
  • All traffic is encrypted end-to-end.

Access Mycelium Cloud

Deploy workloads on Mycelium Cloud and connect to them using your Mycelium connection. Use the Mycelium Cloud dashboard to deploy workloads with Mycelium enabled.

Troubleshooting

App Not Connecting

Using the app:

  1. Restart the app.
  2. Check your internet connection.
  3. Add more peers.
  4. Ensure the app isn't blocked by a firewall.
  5. On Windows, run as administrator.

Command-Line Issues

Can't connect to peers:

  1. Check internet connectivity.
  2. Try different peers.
  3. Check firewall rules.
  4. Ensure IPv6 is enabled.

Can't ping other nodes:

  1. Wait a few minutes for network discovery.
  2. Verify the address.
  3. Check peer connections.

Permission errors (Linux):

  • Must run with sudo to create the network interface.
  • Check executable permissions: chmod +x /usr/local/bin/mycelium.

What's Next?

Now that you're connected, explore what you can do:

  • Remote access – Access services from anywhere.
  • Connect devices – Link multiple locations securely.
  • Mycelium Cloud – Access your Mycelium Cloud deployments.
  • P2P applications – Build distributed systems.

For more advanced setup options (custom ports, private peer networks, proxies, advanced routing), refer to the Mycelium GitHub repository.

Resources

:::tip Connected Successfully? You're now part of the global Mycelium network. Next, explore Mycelium Cloud to run workloads on Mycelium's decentralized infrastructure. :::