From aaf47585133b2d66882779d797f42a8bf759cc58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn-Michael=20Miehe?= <40151420+ldericher@users.noreply.github.com> Date: Thu, 10 Mar 2022 01:56:37 +0100 Subject: [PATCH] documentation --- LICENSE | 21 +++++++++++++++++++++ README.md | 26 ++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a297168 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 yavook.de + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d8c2411 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# kiwi-nextcloud + +[![Build Status](https://github.drone.yavook.de/api/badges/yavook/kiwi-nextcloud/status.svg)](https://github.drone.yavook.de/yavook/kiwi-nextcloud) + +> `kiwi` - simple, consistent, powerful + +Convenience bundle for [`kiwi-scp`](https://github.com/yavook/kiwi-scp). Also [on Docker Hub](https://hub.docker.com/r/yavook/kiwi-nextcloud). + +## Use Case + +`kiwi-nextcloud` bundles the Nextcloud fpm with an nginx proxy as one container. These are commonly deployed as separate containers [like this](https://github.com/nextcloud/docker/blob/master/.examples/docker-compose/insecure/mariadb/fpm/docker-compose.yml). + +The `web` container in these setups is often overlooked and the additional `nginx.conf` needed is an unnecessary source for errors. Standardize your `kiwi-scp` instances! + +Each `kiwi-nextcloud:n` image derives from the official `nextcloud:n-fpm-alpine` images and recognizes the same docker options. + +## Typical usage in `docker-compose.yml` sections: + +```yaml +wep-app: + image: yavook/kiwi-nextcloud:n + volumes: + - nextcloud:/var/www/html +``` + +Refer to the official Nextcloud Guides on how to set up your instance.