path: root/README.md

[![Docker Repository on Quay.io](https://quay.io/repository/sameersbn/nextcloud/status "Docker Repository on Quay.io")](https://quay.io/repository/sameersbn/nextcloud)

# sameersbn/nextcloud:9.0.55

- [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 [Nextcloud](https://nextcloud.com/).

Nextcloud is a self-hosted open source application for file hosting and sharing.

## 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/nextcloud) and is the recommended method of installation.

> **Note**: Builds are also available on [Quay.io](https://quay.io/repository/sameersbn/nextcloud)

```bash
docker pull sameersbn/nextcloud:9.0.55
```

Alternatively you can build the image yourself.

```bash
docker build -t sameersbn/nextcloud github.com/sameersbn/docker-nextcloud
```

## 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-nextcloud/master/docker-compose.yml
```

Update the `NEXTCLOUD_URL` environment variable in the `docker-compose.yml` file with the url from which Nextcloud will be externally accessible.

```bash
docker-compose up
```

Alternatively, you can start Nextcloud manually using the Docker command line.

Step 1. Launch a PostgreSQL container

```bash
docker run --name nextcloud-postgresql -itd --restart=always \
  --env 'DB_NAME=nextcloud_db' \
  --env 'DB_USER=nextcloud' --env 'DB_PASS=password' \
  --volume /srv/docker/nextcloud/postgresql:/var/lib/postgresql \
  sameersbn/postgresql:9.5-4
```

Step 2. Launch the Nextcloud php-fpm container

```bash
docker run --name nextcloud -itd --restart=always \
  --env NEXTCLOUD_URL=http://cloud.example.com:10080 \
  --link nextcloud-postgresql:postgresql \
  --volume /srv/docker/nextcloud/nextcloud:/var/lib/nextcloud \
  sameersbn/nextcloud:9.0.55 app:nextcloud
```

Step 3. Launch a NGINX frontend container

```bash
docker run --name nextcloud-nginx -itd --restart=always \
  --link nextcloud:php-fpm \
  --publish 10080:80 \
  sameersbn/nextcloud:9.0.55 app:nginx
```

Point your browser to `http://cloud.example.com:10080` and login using the default username and password:

* username: **admin**
* password: **password**

> **Note**
>
> Use the `NEXTCLOUD_ADMIN_USER` and `NEXTCLOUD_ADMIN_PASSWORD` variables to create a custom admin user and password on the firstrun instead of the default credentials.

## Persistence

For Nextcloud to preserve its state across container shutdown and startup you should mount a volume at `/var/lib/nextcloud`.

> *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/nextcloud
chcon -Rt svirt_sandbox_file_t /srv/docker/nextcloud
```

# Maintenance

## Creating backups

The image allows users to create backups of the Nextcloud installation using the `app:backup:create` command or the `nextcloud-backup-create` helper script. The generated backup consists of configuration files, uploaded files and the sql database.

Before generating a backup — stop and remove the running instance.

```bash
docker stop nextcloud && docker rm nextcloud
```

Relaunch the container with the `app:backup:create` argument.

```bash
docker run --name nextcloud -it --rm [OPTIONS] \
  sameersbn/nextcloud:9.0.55 app:backup:create
```

The backup will be created in the `backups/` folder of the [Persistent](#persistence) volume. You can change the location using the `NEXTCLOUD_BACKUPS_DIR` configuration parameter.

> **NOTE**
>
> Backups can also be generated on a running instance using:
>
>  ```bash
>  docker exec -it nextcloud nextcloud-backup-create
>  ```

By default backups are held indefinitely. Using the `NEXTCLOUD_BACKUPS_EXPIRY` parameter you can configure how long (in seconds) you wish to keep the backups. For example, setting `NEXTCLOUD_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 nextcloud && docker rm nextcloud
```

Relaunch the container with the `app:backup:restore` argument. Ensure you launch the container in the interactive mode `-it`.

```bash
docker run --name nextcloud -it --rm [OPTIONS] \
  sameersbn/nextcloud:9.0.55 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 nextcloud -it --rm [OPTIONS] \
  sameersbn/nextcloud:9.0.55 app:backup:restore BACKUP=1417624827_nextcloud_backup.tar
```

## Upgrading

To upgrade to newer releases:

  1. Download the updated Docker image:

  ```bash
  docker pull sameersbn/nextcloud:9.0.55
  ```

  2. Stop the currently running image:

  ```bash
  docker stop nextcloud
  ```

  3. Remove the stopped container

  ```bash
  docker rm -v nextcloud
  ```

  4. Start the updated image

  ```bash
  docker run -name nextcloud -itd \
    [OPTIONS] \
    sameersbn/nextcloud:9.0.55
  ```

## 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 nextcloud bash
```