Getting Started
Get your first site up and running with this beginner-friendly guide

Setup

With fission installed, we are ready to set it up on your local machine. If this is your first time using fission, you will be prompted for a username and an email to confirm your new account.
1
$ fission setup
2
🌱 Setting up environment
3
πŸͺ Downloading managed IPFS for Linux
4
πŸŽ›οΈ Configuring managed IPFS
5
generating ED25519 keypair...done
6
peer identity: 12D3KooWHZ3C1tDmzUhgi3A6LYmgBxvv1E1obtG7S2ZkYM1MN83
7
initializing IPFS node at /home/yourname/.config/fission/ipfs
8
πŸ”‘ Creating keys
9
🏠 Do you have an existing account? [Y/n] n
10
Username: YOURNAME
12
βœ… Registration successful! Head over to your email to confirm your account.
13
πŸŽ›οΈ Initializing user config file
14
βœ… Done! Welcome to Fission, YOURNAME ✨.
Copied!
A private key has been generated for your machine and saved in the ~/.config/fission/key/ directory. This key secures your communication with Fission services and works like using an SSH key to connect to GitHub.

Account Linking

If you already have an account created in a web browser, you can link it on your local machine. See the Fission CLI linking guide to link your account.

Create a simple webpage

Let's publish a simple webpage with Fission! We will write a simple webpage, register it as a Fission app, and publish it to the web.
Create a project directory and an index.html file.
1
mkdir hello-universe
2
cd hello-universe
3
touch index.html
Copied!
Add some content to index.html:
index.html
1
<html>
2
<head>
3
<title>Hello Universe!</title>
4
</head>
5
<body>
6
<h1>Hello Universe!</h1>
7
<p>This is a Fission powered page.</p>
8
<p>Assisted by <a href="https://fission.codes">Fission</a>.</p>
9
</body>
10
</html>
Copied!
Run fission app register command to initialize the webpage as a Fission app. You will be prompted for a build directory.
1
$ fission app register
2
πŸ‘· Build directory (.):
Copied!
Press enter to set hello-universe as your build directory, and fission will initialize your app.
1
βœ… App initialized as big-narrow-fuchsia-elf.fission.app
2
⏯️ Next run fission app publish or fission app publish --watch to sync data
3
πŸ’ It may take DNS time to propagate this initial setup globally.
4
In this case, you can always view your app at
5
https://ipfs.runfission.com/ipns/big-narrow-fuchsia-elf.fission.app
Copied!
Fission will create a fission.yaml file with your app configuration.
fission.yaml
1
ignore: []
2
url: big-narrow-fuchsia-elf.fission.app
3
build: .
Copied!
The url is where your webpage will be on the web after it has been published, build tells the fission which directory to publish, and ignore is a list of files and directories to ignore. See the Fission YAML guide for more details.
Run fission app publish to publish the webpage.
1
$ fission app publish
2
πŸ•šπŸ›« App publish local preflight
3
✈️ Pushing to remote
4
πŸš€ Now live on the network
5
πŸ“ DNS updated! Check out your site at:
6
πŸ”— big-narrow-fuchsia-elf.fission.app
Copied!
Copy the URL from the last line and paste it into your web browser to view the webpage live on the web. Nice and simple!
It may take a few minutes for DNS to propagate. If you don't see the webpage live at the URL, come back and try again in a bit. You can also take the URL from the CLI output and view the webpage athttps://ipfs.runfission.com/ipfs/{URL}right away.
Last modified 3mo ago
Export as PDF
Copy link