@cinderlink/server-bin
v0.1.0
Published
Cinderlink server binary
Downloads
51
Readme
@cinderlink/server-bin
This package provides a binary for the Cinderlink server.
The binary runs a js-ipfs node via @cinderlink/client and accompanying HTTP API & Gateway server.
The server will store IPFS repository data in the cinderlink/
directory in the current working directory.
Installation
pnpm add @cinderlink/server-bin
Usage Example
For an example server configuration with a custom plugin, see this example.
Commands
cinderlink init
Initializes a new Cinderlink server. This command will create a cinderlink.config.js
file in the current working directory.
init options
--pkey
- Indicates that the server should look for a private key in the environment atCINDERLINK_PRIVATE_KEY
. If this option is not provided, the server will instead look for a mnemonic in the environment atCINDERLINK_MNEMONIC
.--env
- Also generate an environment file for the server.
cinderlink init-env
Initializes a new environment file for the Cinderlink server. This command will create a .env
file in the current working directory.
init-env options
--pkey
- Use a private key instead of a mnemonic.
cinderlink start
Starts the Cinderlink server. This command will look for a cinderlink.config.js
file in the current working directory.
start options
--env
- Specify an environment file to load for the server.