Fission YAML

More information on global and app YAML configuration files.

Fission stores global and app configuration options in YAML files. The global configuration is stored in a config.yaml file and app configurations are stored in fission.yaml files.

Global Fission YAML

After you run fission user register, you will have a global config.yaml in your ~/.config/fission/ folder. You can open config.yaml in a text editor or display it at the command line.

more ~/.config/fission/config.yaml

The default global config.yaml will looks something like this:

ignore: []
username: fission
server_did: did:key:zStEZpzSMtTt9k2vszgvCwF4fLQQSyA15W5AQ4z3AR6Bx4eFJ5crJFbuGxKmbma4
peers:
- /dns4/node.runfission.com/tcp/4001/ipfs/QmVLEz2SxoNiFnuyLpbXsH6SvjPTrHNMU88vCQZyhgBzgw
- /ip4/3.226.224.78/tcp/4001/p2p/QmPeeeZZXxMBAPxxba7a6ggjDr5jLuD3RAFnmPPcvJ9fMS
- /ip4/3.226.224.78/udp/4001/quic/p2p/QmPeeeZZXxMBAPxxba7a6ggjDr5jLuD3RAFnmPPcvJ9fMS
signing_key_path: /home/fission/.config/fission/key/machine_id.ed25519

In most cases, the only thing you will want to change in this file is the ignore section. The other sections are managed by the Fission CLI.

ignore

Ignore is a list of files you don't want fission app publish to publish. For example, you might add commonly ignored files and secrets.

ignore: [".DS_Store", ".env"]

Ignore follows the same conventions used in a .gitignore file.

username

Username is a name you select for yourself during fission setup.

server_did

Server DID is the identity of the Fission server that authenticates your requests when using the Fission CLI.

peers

We configure your machine to directly connect to our servers. The peers are the IP addresses and fingerprints of our servers.

Eventually, we'll have a list of peers around the world.

signing_key_path

The path to the key used to sign requests made when using the Fission CLI.

Fission YAML for Apps

When you create a new app with fission app register, a fission.yaml file is created in the directory where you ran the command. The default fission.yaml file looks something like:

ignore: []
url: junior-angular-tulip.fission.app
build: ./dist

ignore

Ignore works the same as the ignore in the global configuration. You can use it to list files that you do not want to publish.

ignore:
- node_modules
- *.psd

You might use it to ignore a directory like node_modules or all files with an extension like Photoshop .psd files.

YAML can specify lists in a couple of different ways, both like this, or as comma-separated list shown in the global config.yaml example above.

url

The URL where your app is viewable after it has been published.

Eventually, you will be able to publish different versions of your app -- for example, development, testing, production, etc. -- and use custom domains for your app.

build

The build directory is the directory the Fission CLI will publish. Use this when you have a build step that produces a production-ready version of your application.

The build directory is set as a relative path from the location of the fission.yaml file.

If you are using a "common" build directory, the Fission CLI will attempt to detect it the first time you run fission app register. It will prompt you and ask if you would like to use the directory it detects.