From 78de7ed98abff93fe5fef94907bcfa4f76dcef07 Mon Sep 17 00:00:00 2001 From: Steve Manuel Date: Sat, 27 May 2017 10:27:51 -0700 Subject: adding docs to repo --- docs/build/System-Deployment/Docker/index.html | 977 +++++++++++++++++++++ docs/build/System-Deployment/SysV-Style/index.html | 899 +++++++++++++++++++ 2 files changed, 1876 insertions(+) create mode 100644 docs/build/System-Deployment/Docker/index.html create mode 100644 docs/build/System-Deployment/SysV-Style/index.html (limited to 'docs/build/System-Deployment') diff --git a/docs/build/System-Deployment/Docker/index.html b/docs/build/System-Deployment/Docker/index.html new file mode 100644 index 0000000..557b538 --- /dev/null +++ b/docs/build/System-Deployment/Docker/index.html @@ -0,0 +1,977 @@ + + + + + + + + + + + + + + + + + + Docker - Ponzu + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + +
+
+ + +
+
+
+ +
+
+
+ + +
+
+
+ + +
+
+
+ + +
+
+ + + +

Docker

+ +

Ponzu Docker build

+

Ponzu is distributed as a docker image, +which aids in ponzu deployment. The Dockerfile in this directory is used by Ponzu +to generate the docker image which contains the ponzu executable.

+

If you are deploying your own Ponzu project, you can write a new Dockerfile that +is based from the ponzu/ponzu image of your choice. For example:

+
FROM ponzu/ponzu:latest
+
+# your project set up ...
+# ...
+# ...
+
+ + +

The following are convenient commands during development of Ponzu core:

+

Build the docker image. Run from the root of the project.

+
# from the root of ponzu:
+docker build -t ponzu-dev
+
+ + +

Start the image, share the local directory and pseudo terminal (tty) into for debugging:

+
docker run -v $(pwd):/go/src/github.com/ponzu-cms/ponzu -it ponzu-dev
+pwd # will output the go src directory for ponzu
+ponzu version # will output the ponzu version
+# make an edit on your local and rebuild
+go install ./...
+
+ + +

Special thanks to @krismeister for contributing this!

+ + + + + + + +
+
+
+
+ + + + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/System-Deployment/SysV-Style/index.html b/docs/build/System-Deployment/SysV-Style/index.html new file mode 100644 index 0000000..25df784 --- /dev/null +++ b/docs/build/System-Deployment/SysV-Style/index.html @@ -0,0 +1,899 @@ + + + + + + + + + + + + + + + + + + Deploying Ponzu on Linux with System-V style init + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + +
+
+ + +
+
+
+ +
+
+
+ + +
+
+
+ + +
+
+
+ + +
+
+ + + +

SysV Style

+ +

For reference, here is an example init script to run Ponzu servers. You must +define the PROJECT_DIR & RUNAS variables by replacing <PROJECT DIRECTORY> +& <USER> in the script below:

+
#!/bin/sh
+### BEGIN INIT INFO
+# Provides:          ponzu-server
+# Required-Start:    $local_fs $network $named $time $syslog
+# Required-Stop:     $local_fs $network $named $time $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Description:       Ponzu API & Admin server
+### END INIT INFO
+
+PROJECT_DIR=<PROJECT DIRECTORY>
+SCRIPT='cd $PROJECT_DIR && ponzu run --port=80' # add --https here to get TLS/HTTPS
+RUNAS=<USER>
+
+PIDFILE=/var/run/ponzu-server.pid
+LOGFILE=/var/log/ponzu-server.log
+
+start() {
+  if [ -f /var/run/$PIDNAME ] && kill -0 $(cat /var/run/$PIDNAME); then
+    echo 'Service already running' >&2
+    return 1
+  fi
+  echo 'Starting service…' >&2
+  local CMD="$SCRIPT &> \"$LOGFILE\" & echo \$!"
+  su -c "$CMD" $RUNAS > "$PIDFILE"
+  echo 'Service started' >&2
+}
+
+stop() {
+  if [ ! -f "$PIDFILE" ] || ! kill -0 $(cat "$PIDFILE"); then
+    echo 'Service not running' >&2
+    return 1
+  fi
+  echo 'Stopping service…' >&2
+  kill -15 $(cat "$PIDFILE") && rm -f "$PIDFILE"
+  echo 'Service stopped' >&2
+}
+
+uninstall() {
+  echo -n "Are you really sure you want to uninstall this service? That cannot be undone. [yes|No] "
+  local SURE
+  read SURE
+  if [ "$SURE" = "yes" ]; then
+    stop
+    rm -f "$PIDFILE"
+    echo "Notice: log file is not be removed: '$LOGFILE'" >&2
+    update-rc.d -f <NAME> remove
+    rm -fv "$0"
+  fi
+}
+
+case "$1" in
+  start)
+    start
+    ;;
+  stop)
+    stop
+    ;;
+  uninstall)
+    uninstall
+    ;;
+  restart)
+    stop
+    start
+    ;;
+  *)
+    echo "Usage: $0 {start|stop|restart|uninstall}"
+esac
+
+ + + + + + + +
+
+
+
+ + + + +
+ + + + + + + + + + + + \ No newline at end of file -- cgit v1.2.3