Skip to content
Dockerized version of ffrk-proxy
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
hooks
Dockerfile
Makefile
README.MD
VERSION
docker-compose.yml

README.MD

jdel/docker-ffrk-proxy:0.11.0

Introduction

Dockerfile to create a Docker container image for FFRK Proxy.

FFRK Proxy is a proxy for Final Fantasy Record Keeper written in node.js.

Contributing

If you find this image useful here's how you can help:

  • Send a pull request with your awesome features and bug fixes
  • Help users resolve their issues.

Issues

Before reporting your issue please try updating Docker to the latest version and check if it resolves the issue. Refer to the Docker installation guide for instructions.

Getting started

Installation

Builds are available on Docker Hub.

docker pull jdel/ffrk-proxy:0.11.0

Alternatively you can build the image yourself.

docker build -t jdel/ffrk-proxy github.com/jdel/docker-ffrk-proxy

Quickstart

Start FFRK Proxy using:

docker run --name ffrk-proxy -d --restart=always \
  --publish 5050:5050 --publish 5051:5051 \
  jdel/ffrk-proxy:0.11.0

Alternatively, you can use the sample docker-compose.yml file to start the container using Docker Compose

Keep in mind to modify or delete the volume from docker-compose.yml if you just want the quick setup

Persistence

In order to be able to change the config file, you should mount a volume at /ffrk/config.

The Quickstart command already mounts a volume for persistence.

When using a you need to set environment variables matching the ports in the config

docker run --name ffrk-proxy -d --restart=always \
  -p 6050:6050 -p 6051:6051 -e config=my_config_6050 \
  -e proxy_port=6050 -e cert_port=6051 \
  -v /srv/docker/ffrk/:/ffrk/config \
  jdel/ffrk-proxy:0.11.0

Maintenance

Upgrading

To upgrade to newer releases:

  1. Download the updated Docker image:
docker pull jdel/ffrk-proxy:0.11.0
  1. Stop the currently running image:
docker stop ffrk-proxy
  1. Remove the stopped container
docker rm -v ffrk-proxy
  1. Start the updated image
docker run -name ffrk-proxy -d \
  [OPTIONS] \
  jdel/ffrk-proxy:0.11.0

Shell Access

For debugging and maintenance purposes you may want access the containers shell. If you are using Docker version 1.3.0 or higher you can access a running containers shell by starting ash using docker exec:

docker exec -it ffrk-proxy ash

References

You can’t perform that action at this time.