Deployment

Pecans can be easily be deployed to a state-less server or PaaS. It only uses the disk as a cache for assets.

On Heroku:

Heroku is the perfect solution to host a Pecans instance.

With docker

Pecans can also be run as a Docker container:

docker run -it -p 80:80 -e GITHUB_REPO=username/repo gitbook/pecans

On your own server:

Install dependencies using:

$ npm install

This service requires to be configured using environment variables:

# Set the port for the service
$ export PORT=6000

# Access token for the GitHub API (requires permissions to access the repository)
# If the repository is public you do not need to provide an access token
# you can also use GITHUB_USERNAME and GITHUB_PASSWORD
$ export GITHUB_TOKEN=...

# ID for the GitHub repository
$ export GITHUB_REPO=Username/MyApp

# Authentication for the private API
$ export API_USERNAME=hello
$ export API_PASSWORD=world

# Express's "trust proxy" setting for trusting X-Forwarded-* headers when
# behind a reverse proxy like nginx
# http://expressjs.com/en/guide/behind-proxies.html
$ export TRUST_PROXY=loopback

Then start the application using:

$ npm start