backend

README

Backend

The main purpose of this part is to serve information and plugins list, configured by the back-office.

How to run the backend

With Docker

You can run the backend server with the provided docker image :

docker container run \
  -d -p 8090:8090 \
  -v $(pwd)/data:/backend/data \
  -v $(pwd)/plugins:/backend/plugins \
  -v $(pwd)/medias:/backend/medias \
  -v $(pwd)/logs:/backend/logs \
  zenika/marcel-backend

• /backend/data/ is a volume that contains persitent data. It should contains the plugin catalog in plugins.json (see plugins README). The backend will generate a medias.json if it doesn/t exist.
• /backend/plugins/ is a volume that contains all the plugins files. Each plugin registered in the plugins.json catalog should have a folder with its eltName name.
• /bakcend/medias/ is a volume that should not be modified. It stores internal copies and data for each medias and plugins.
• /backend/logs/ is the volume containing the backend logs file.

With compiled exectubale

Once built, you can run the exectuable as a background job :

./marcel-backend &

The backend expect a specific file architecture for the working directory :

working_directory
  |__ data/
  |   |__ plugins.json
  |   |__ medias.json
  |
  |__ medias/
  |   |__ ...
  |
  |__ plugins/
  |   |__ plugin1/
  |   |   |__ frontend/
  |   |       |__ index.html
  |   |       |__ style.html
  |   |
  |   |__ plugin2/
  |   |   |__ frontend/
  |   |   |   |__ index.html
  |   |   |__ backend/
  |   |       |__ docker_image.tar
  |   |
  |   |__ ...
  |
  |__ marcel.log

• data/ folder is used to store persistente data. It should contains the plugin catalog in plugins.json (see plugins README). The backend will generate a medias.json if it doesn/t exist.
• medias/ folder should not be modified. It stores internal copies and data for each medias and plugins.
• plugins/ folder contains all the plugins files. Each plugin registered in the plugins.json catalog should have a folder with its eltName name.
• marcel.log is the default location for logs.

How to build the backend

Dependencies

Install dependencies with dep :

go get -u github.com/golang/dep/cmd/dep
dep ensure -vendor-only

Build server

You can build the server by running :

go build -o marcel-backend

You should then be able to run the server :

./marcel-backend

By default, the logs can be seen in the file marcel.log in the working directory. You can change this default :

export MARCEL_LOG_FILE="path_to_log_file" # defaults to $PWD/marcel.log

Build cross architecture :

env GOOS=linux GOARCH=arm go build -o marcel-backend-arm

List of all GOOS and GOARCH values : https://golang.org/doc/install/source#environment

Build for Docker :

A Go executable needs some external library missing from alpine docker image. To compile a staticly linked executable usable for building the docker image, run :

GOOS=linux CGO_ENABLED=0 go build -a -installsuffix cgo

Generate swagger.json generation

Install library :

go get -u github.com/go-swagger/go-swagger/cmd/swagger

or without docker :

docker pull quay.io/goswagger/swagger
alias swagger="docker run --rm -it -v $HOME:$HOME -w $(pwd) quay.io/goswagger/swagger"

Generate the API doc :

swagger generate spec -o ./swagger.json

You can now run Swagger UI on port 3000

Credits

• Gorilla Mux
• MapStructure from Mitchellh
• Go-Swagger.io

Documentation

Overview

Package main MARCEL APIs

Provide API to access medias information

Host: localhost:8090
BasePath: /api/v1/
Version: 1.1
License: MIT http://opensource.org/licenses/MIT
Contact: Gwennael Buchet<gwennael.buchet@gmail.com>

swagger:meta