Skip to main content

Deploy on Nife button

The Deploy on Nife button lets anyone deploy your public GitHub repository on Nife with one click from your README. Add it to a project so people can try it without setting anything up first.

Add the button to your README​

Paste this into your README.md. Replace YOUR-ORG and YOUR-REPO with your GitHub account or organization and your repository name.

<a href="https://launch.nife.io/deploy-app/start?repository-url=https://github.com/YOUR-ORG/YOUR-REPO">
  <img src="https://launch.nife.io/deploy-on-nife.svg" alt="Deploy on NIFE" width="280" />
</a>

The repository must be public. Nife's sample project, node-multiplayer-snake, uses this button in its README: https://github.com/nifetency/node-multiplayer-snake

What happens when someone clicks it​

  1. The button opens Nife with your repository address included in the link.
  2. The person signs in to Nife, or creates an account.
  3. Nife looks at the repository and works out the runtime, build settings and ports for you.
  4. The person reviews the settings, then deploys.

Make your repository ready​

  • Add a Dockerfile, or make sure your project uses a language runtime that Nife supports (such as Node.js, Python, Go, Java, Ruby, PHP, Rust or .NET).
  • Make your app listen on the port you document in your README.
  • List any environment variables your app needs in your README, so people know what to set.
  • Do not commit secrets such as API keys or tokens.

Deploy without the button​

You can deploy any repository, public or private, from the dashboard. See Deploy Application from Git. If you prefer the command line, see the nifectl commands.

Troubleshooting​

  • The button opens a page that cannot find the repository: check that the repository is public and that the address in the link is spelled correctly.
  • The build fails: check the build logs, and confirm your Dockerfile or runtime settings are correct.
  • The app starts but is not reachable: confirm the port your app listens on matches the port in the deployment settings.

Need help? Email support@nife.io.