deploio-examples

This repository hosts example code for different languages and frameworks supported by Deploio. More information can be found in the Deploio User Guides or in the Nine Platform Reference.

Go

nctl create application go \
  --git-url=https://github.com/ninech/deploio-examples \
  --git-sub-path=go

Ruby

This requires the rails command to be installed for the SECRET_KEY_BASE. If you don't have it, any long random string will do (127+ chars).

nctl create application rails \
  --git-url=https://github.com/ninech/deploio-examples \
  --git-sub-path=ruby/rails-basic \
  --env=SECRET_KEY_BASE=$(rails secret)

Node.js

nctl create application nextjs \
  --git-url=https://github.com/ninech/deploio-examples \
  --git-sub-path=nodejs/nextjs \
  --build-env=NODE_ENV="production" \
  --env=NODE_ENV="production"

PHP

A plain PHP application without a framework is provided at php/plain. You can launch it with:

nctl create application php-plain \
  --git-url=https://github.com/ninech/deploio-examples \
  --git-sub-path=php/plain \
  --build-env=BP_PHP_WEB_DIR=public \
  --build-env=BP_COMPOSER_INSTALL_OPTIONS="--ignore-platform-reqs"

We also provide a Symfony sample application that makes use of all currently available services on Deploio. For the Symfony application to work, you will need to set up a database, a key value store and object storage as explained in the tutorial.

nctl create application symfony \
  --git-url=https://github.com/ninech/deploio-examples \
  --git-sub-path=php/symfony\
  --build-env=BP_PHP_WEB_DIR=public \
  --build-env=BP_COMPOSER_INSTALL_OPTIONS="--ignore-platform-reqs --no-scripts -o"

Python

The example provides a Django application which shows a random message on every page reload. It uses a temporary local sqlite database. Please note that the database will be recreated on every deployment or restart of the application (all data will be lost), so it really just is useful for demonstration purposes. For persistent data, please use a postgres or mysql external database. The Django admin interface can be used to add messages. Just visit https://<URL of app>/admin to access it and use the user credentials which you pass via the env variables below to login. Please also define the SECRET_KEY which is used to secure signed data and should be kept secret.

nctl create application django-example \
  --git-url=https://github.com/ninech/deploio-examples \
  --git-sub-path=python/django \
  --env=DJANGO_SU_NAME=admin \
  [email protected] \
  --env=DJANGO_SU_PASSWORD=<INSERT A PASSWORD HERE> \
  --env=SECRET_KEY=<VERY LONG RANDOM SECRET KEY>

Static

For static sites we have two examples:

• just a plain index.html

  nctl create application static-html \
    --git-url=https://github.com/ninech/deploio-examples \
    --git-sub-path=static/html

• a frontend react app built with npm

  nctl create application static-react \
    --git-url=https://github.com/ninech/deploio-examples \
    --git-sub-path=static/react

Dockerfile

With Dockerfile builds, Deploio can build any app that can be built using a Dockerfile. To demonstrate this we have the following sample apps:

• a very basic Rust app:

  nctl create application dockerfile-rust \
  --git-url=https://github.com/ninech/deploio-examples \
  --git-sub-path=dockerfile/rust \
  --dockerfile

• a Java app based on Spring Boot that integrates with an On-Demand Key-Value Store:

  nctl create application dockerfile-java-kvs \
  --git-url=https://github.com/ninech/deploio-examples \
  --git-sub-path=dockerfile/java-kvs \
  --env=KVS_HOST=<KEY-VALUE STORE HOSTNAME FROM COCKPIT OR NCTL> \
  --env=KVS_PASSWORD=<KEY-VALUE STORE PASSWORD FROM COCKPIT OR NCTL> \
  --env=KVS_SSL_ENABLED=true \
  --dockerfile

  See dockerfile/java-kvs/README.md for details and full setup instructions.

KVS

This example uses an On-Demand Key-Value Store.To get started, you'll need to first create a KVS instance - either through nctl or via the Cockpit interface:

nctl create kvs <kvs-name>

Once your instance is ready you can create the app using the command below. You’ll need the instance’s connection details (FQDN and TOKEN), which can be retrieved using nctl or found in Cockpit under “Access Information.” For more details, see Key-Value Store docs:

export KVS_PASSWORD=$(nctl get kvs test --print-token)
export KVS_HOST=$(nctl get kvs test -o yaml | yq '.status.atProvider.fqdn')
nctl create application go \
  --git-url=https://github.com/ninech/deploio-examples \
  --git-sub-path=kvs \
  --env="KVS_HOST=$KVS_HOST;KVS_PASSWORD=$KVS_PASSWORD"