https://github.com/sameersbn/docker-invoiceplane
Dockerfile to create a Docker container image for InvoicePlane
https://github.com/sameersbn/docker-invoiceplane
Last synced: 3 months ago
JSON representation
Dockerfile to create a Docker container image for InvoicePlane
- Host: GitHub
- URL: https://github.com/sameersbn/docker-invoiceplane
- Owner: sameersbn
- License: mit
- Created: 2015-09-07T08:48:21.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-07-06T08:07:51.000Z (almost 6 years ago)
- Last Synced: 2025-03-15T21:47:44.714Z (3 months ago)
- Language: Shell
- Size: 147 KB
- Stars: 45
- Watchers: 4
- Forks: 53
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://quay.io/repository/sameersbn/invoiceplane)
# sameersbn/invoiceplane:1.5.9-3
- [Introduction](#introduction)
- [Contributing](#contributing)
- [Issues](#issues)
- [Getting started](#getting-started)
- [Installation](#installation)
- [Quickstart](#quickstart)
- [Persistence](#persistence)
- [Maintenance](#maintenance)
- [Creating backups](#creating-backups)
- [Restoring backups](#restoring-backups)
- [Upgrading](#upgrading)
- [Shell Access](#shell-access)
# Introduction
`Dockerfile` to create a [Docker](https://www.docker.com/) container image for [InvoicePlane](https://invoiceplane.com/).
InvoicePlane is a self-hosted open source application for managing your quotes, invoices, clients and payments.
## 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?q=is%3Aopen+is%3Aissue).
- Support the development of this image with a [donation](http://www.damagehead.com/donate/)
## 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](https://docs.docker.com/installation) for instructions.
SELinux users should try disabling SELinux using the command `setenforce 0` to see if it resolves the issue.
If the above recommendations do not help then [report your issue](../../issues/new) along with the following information:
- Output of the `docker version` and `docker info` commands
- The `docker run` command or `docker-compose.yml` used to start the image. Mask out the sensitive bits.
- Please state if you are using [Boot2Docker](http://www.boot2docker.io), [VirtualBox](https://www.virtualbox.org), etc.
# Getting started
## Installation
Automated builds of the image are available on [Dockerhub](https://hub.docker.com/r/sameersbn/invoiceplane) and is the recommended method of installation.
> **Note**: Builds are also available on [Quay.io](https://quay.io/repository/sameersbn/invoiceplane)
```bash
docker pull sameersbn/invoiceplane:1.5.9-3
```
Alternatively you can build the image yourself.
```bash
docker build -t sameersbn/invoiceplane github.com/sameersbn/docker-invoiceplane
```
## Quickstart
The quickest way to start using this image is with [docker-compose](https://docs.docker.com/compose/).
```bash
wget https://raw.githubusercontent.com/sameersbn/docker-invoiceplane/master/docker-compose.yml
```
Update the `INVOICEPLANE_URL` environment variable in the `docker-compose.yml` file with the url from which InvoicePlane will be externally accessible.
```bash
docker-compose up
```
Alternatively, you can start InvoicePlane manually using the Docker command line.
Step 1. Launch a MySQL container
```bash
docker run --name invoiceplane-mysql -itd --restart=always \
--env 'DB_NAME=invoiceplane_db' \
--env 'DB_USER=invoiceplane' --env 'DB_PASS=password' \
--volume /srv/docker/invoiceplane/mysql:/var/lib/mysql \
sameersbn/mysql:5.2.26
```
Step 2. Launch the InvoicePlane php-fpm container
```bash
docker run --name invoiceplane -itd --restart=always \
--link invoiceplane-mysql:mysql \
--env 'INVOICEPLANE_FQDN=invoice.example.com' \
--env 'INVOICEPLANE_TIMEZONE=Asia/Kolkata' \
--volume /srv/docker/invoiceplane/invoiceplane:/var/lib/invoiceplane \
sameersbn/invoiceplane:1.5.9-3 app:invoiceplane
```
Step 3. Launch a NGINX frontend container
```bash
docker run --name invoiceplane-nginx -itd --restart=always \
--link invoiceplane:php-fpm \
--volumes-from invoiceplane \
--publish 10080:80 \
sameersbn/invoiceplane:1.5.9-3 app:nginx
```
Point your browser to [http://invoice.example.com:10080/setup](http://invoice.example.com:10080/setup) to complete the setup.
## Persistence
For InvoicePlane to preserve its state across container shutdown and startup you should mount a volume at `/var/lib/invoiceplane`.
> *The [Quickstart](#quickstart) command already mounts a volume for persistence.*
SELinux users should update the security context of the host mountpoint so that it plays nicely with Docker:
```bash
mkdir -p /srv/docker/invoiceplane
chcon -Rt svirt_sandbox_file_t /srv/docker/invoiceplane
```
# Maintenance
## Creating backups
The image allows users to create backups of the InvoicePlane installation using the `app:backup:create` command or the `invoiceplane-backup-create` helper script. The generated backup consists of uploaded files and the sql database.
Before generating a backup — stop and remove the running instance.
```bash
docker stop invoiceplane && docker rm invoiceplane
```
Relaunch the container with the `app:backup:create` argument.
```bash
docker run --name invoiceplane -it --rm [OPTIONS] \
sameersbn/invoiceplane:1.5.9-3 app:backup:create
```
The backup will be created in the `backups/` folder of the [Persistent](#persistence) volume. You can change the location using the `INVOICEPLANE_BACKUPS_DIR` configuration parameter.
> **NOTE**
>
> Backups can also be generated on a running instance using:
>
> ```bash
> docker exec -it invoiceplane invoiceplane-backup-create
> ```
By default backups are held indefinitely. Using the `INVOICEPLANE_BACKUPS_EXPIRY` parameter you can configure how long (in seconds) you wish to keep the backups. For example, setting `INVOICEPLANE_BACKUPS_EXPIRY=604800` will remove backups that are older than 7 days. Old backups are only removed when creating a new backup, never automatically.
## Restoring Backups
Backups created using instructions from the [Creating backups](#creating-backups) section can be restored using the `app:backup:restore` argument.
Before restoring a backup — stop and remove the running instance.
```bash
docker stop invoiceplane && docker rm invoiceplane
```
Relaunch the container with the `app:backup:restore` argument. Ensure you launch the container in the interactive mode `-it`.
```bash
docker run --name invoiceplane -it --rm [OPTIONS] \
sameersbn/invoiceplane:1.5.9-3 app:backup:restore
```
A list of existing backups will be displayed. Select a backup you wish to restore.
To avoid this interaction you can specify the backup filename using the `BACKUP` argument to `app:backup:restore`, eg.
```bash
docker run --name invoiceplane -it --rm [OPTIONS] \
sameersbn/invoiceplane:1.5.9-3 app:backup:restore BACKUP=1417624827_invoiceplane_backup.tar
```
## Upgrading
To upgrade to newer releases:
1. Download the updated Docker image:
```bash
docker pull sameersbn/invoiceplane:1.5.9-3
```
2. Stop the currently running image:
```bash
docker stop invoiceplane
```
3. Remove the stopped container
```bash
docker rm -v invoiceplane
```
4. Start the updated image
```bash
docker run -name invoiceplane -itd \
[OPTIONS] \
sameersbn/invoiceplane:1.5.9-3
```
Point your browser to [http://invoice.example.com:10080/setup](http://invoice.example.com:10080/setup) to complete the upgrade.
## 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 `bash` using `docker exec`:
```bash
docker exec -it invoiceplane bash
```