treehouses/cli/services

About

The treehouses services module relies on install scripts for each individual service.

These install scripts create the necessary docker-compose yml file(s) and contain different information about the service, such as the size of the service and the port it uses.

These install scripts are named install-<service>.sh and are located inside the /services/directory.

Look at the pre-existing install scripts in /services/ for examples.

An empty install script is shown below.

Adding a new service

Using the template, fill in the sections as required.

1. create service directory

   Replace <service> with the name of your service.

     mkdir -p /srv/<service>
   

   Additionally, if your service requires any special commands to be run before being used, add them here.

2. create yml(s)

   Replace <yml code> with the svg icon code of your service.

   Replace <service>/<service> with the name of your service.

   cat << EOF > /srv/<service>/<service>.yml
   

3. create .env (if needed)

   If your service has environment variables, add them to this .env file. Replace <service> with the name of your service.

   {
     echo "EXAMPLE_VAR="
   } > /srv/<service>/.env
   

   Remember to edit your .yml to take these environment variables.

   {
     echo "    environment:"
     echo "      - EXAMPLE=\${EXAMPLE_VAR}"
   }
   

4. add autorun

   Replace <service>s with the name of your service.

     cat << EOF > /srv/<service>/autorun
   <service>_autorun=true
   
   if [ "$<service>_autorun" = true ]; then
     treehouses services <service> up
   fi
   
   
   EOF
   

5. environment variable check

   echo true or echo false depending on whether or not your service uses environment variables.

6. supported arch check

   echo <arch> depending on supported architecture(s):

   armv6l
   armv7l
   i686
   x86_64
   aarch32
   aarch64
   

7. add port(s)

   Replace <port> with the port(s) your service uses.

   If your service uses multiple ports, add each port on their own individual lines.

     echo "<port>"
   

8. add path(s)

   Replace <path> with the path(s) your service uses.

   If your service has specific path, add path on their own individual lines.

     echo "<path>"
   

9. add size (in MB)

   Replace <size> with the size of your service in MB (leave out the MB units).

     echo "<size>"
   

10. add description

    Replace <description> with a short description of your service.

      echo "\"<description>\""
    

11. add info

    Replace <url> with the url of your service (eg. GitHub repository).

      echo "<url>"
    

    Replace <description> with a short description of your service.

      echo "\"<description>\""
    

12. add svg icon

    Replace <svg icon code> with the svg icon code of your service.

    Note that EOF cannot have any whitespace in front of it.

      cat <<EOF
    <svg icon code>
    EOF
    

Save the file as install-<service>.sh inside the /services/ directory.

Template

#!/bin/bash

function install {
  # create service directory
  mkdir -p /srv/<service>

  # create yml(s)
  cat << EOF > /srv/<service>/<service>.yml
<yml code>
EOF

  # create .env with default values
  {
    echo "EXAMPLE_VAR="
  } > /srv/<service>/.env

  # add autorun
  cat << EOF > /srv/<service>/autorun
<service>_autorun=true

if [ "$<service>_autorun" = true ]; then
  treehouses services <service> up
fi


EOF
}

# environment var
function uses_env {
  echo true/false
}

# add supported arch(es)
function supported_arches {
  echo "<arch>"
}

# add port(s)
function get_ports {
  echo "<port>"
}

# add path(s)
#function get_paths {
#  echo "<path>"
#}

# add size (in MB)
function get_size {
  echo "<size>"
}

# add description
function get_description {
  echo "<description>"
}

# add info
function get_info {
  echo "<url>"
  echo
  echo "\"<description>\""
}

# add svg icon
function get_icon {
  cat <<EOF
<svg icon code>
EOF
}