Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shoekstra/puppet-owncloud
Puppet module to install and configure ownCloud
https://github.com/shoekstra/puppet-owncloud
owncloud puppet
Last synced: 3 months ago
JSON representation
Puppet module to install and configure ownCloud
- Host: GitHub
- URL: https://github.com/shoekstra/puppet-owncloud
- Owner: shoekstra
- License: apache-2.0
- Created: 2014-08-28T08:26:34.000Z (over 10 years ago)
- Default Branch: develop
- Last Pushed: 2016-06-08T23:06:12.000Z (over 8 years ago)
- Last Synced: 2024-03-14T23:07:14.413Z (10 months ago)
- Topics: owncloud, puppet
- Language: Ruby
- Homepage:
- Size: 158 KB
- Stars: 6
- Watchers: 3
- Forks: 26
- Open Issues: 2
-
Metadata Files:
- Readme: README.markdown
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/shoekstra/puppet-owncloud)
[](https://forge.puppetlabs.com/shoekstra/owncloud)
ownCloud
========
#### Table of Contents
1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
3. [Setup - The basics of getting started with ownCloud](#setup)
* [What ownCloud affects](#what-owncloud-affects)
* [Setup requirements](#setup-requirements)
* [Beginning with ownCloud](#beginning-with-owncloud)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
## Overview
The ownCloud module eases installation and initial configuration of ownCloud.
## Module Description
ownCloud is a software system for what is commonly termed "file hosting" and is very similar to the widely-used Dropbox, with the primary difference being that ownCloud is free and open-source, allowing anyone to install and operate it without charge on a private server.
This module provides a simple way to install ownCloud, and optionally include Apache and virtual host configuration, database creation, and an autoconfigured ownCloud instance ready for you to log into. It preconfigures the ownCloud instance using the [automatic configuration method](http://doc.owncloud.org/server/7.0/admin_manual/configuration/configuration_automation.html "Defining Automatic Configuration").
## Setup
### What owncloud affects
* ownCloud configuration files and directories
* package/service/configuration files for Apache
* Apache module and virtual hosts
* MySQL database and user creation (does not install a MySQL server)
* PHP server-side components and required modules
* **WARNING**: If module is set to manage Apache (enabled by default), any existing Apache configuration not Puppet managed may be purged.
### Setup Requirements
In order to use the [PuppetLabs MySQL module](https://github.com/puppetlabs/puppetlabs-mysql) to create the database on a separate database server, you will need to have [exported resources functionality](https://docs.puppetlabs.com/puppet/latest/reference/lang_exported.html "Exported Resources").
If Apache is not installed, the default behaviour of this module is to install it. If you're already managing an Apache install with Puppet (or want to amend any of the Apache related configuration), set `manage_apache` to false and ensure the php, rewrite and ssl mods are enabled, e.g.:
```puppet
class { '::apache':
...
default_vhost => false,
mpm_module => 'prefork',
purge_configs => false,
}
include '::apache::mod::php', '::apache::mod::rewrite', '::apache::mod::ssl'
class { '::owncloud':
...
manage_apache => false,
}
```
### Beginning with ownCloud
To install ownCloud with the default parameters:
```puppet
class { 'owncloud': }
```
The defaults are determined by your operating system (e.g. Debian systems have one set of defaults, and RedHat systems have another). These defaults will work well in a testing environment, but are not suggested for production as they result in:
* An 'owncloud' database and user being created (password 'owncloud')
* Apache installed, with a default vhost of "owncloud.$::domain"
* ownCloud configured to use MySQL as the database backend (does not install a MySQL server)
* ownCloud data directory (where user files are kept) located at $documentroot/data (this should be moved out of the document root before being put on the Internet)
#### Install on a single server
To install ownCloud on a single server, (using the [PuppetLabs MySQL module](https://github.com/puppetlabs/puppetlabs-mysql) to install MySQL and create a 'owncloud' database):
```puppet
class { '::mysql::server':
override_options => {
'mysqld' => { 'bind-address' => '0.0.0.0' }
},
restart => true,
root_password => 'sup3rt0ps3cr3t',
}
class { '::owncloud':
...
db_user => 'owncloud',
db_pass => 'p4ssw0rd',
}
```
#### Install on separate database and web server
To install ownCloud on a web server with a separate MySQL database server, on your web server:
```puppet
class { '::owncloud':
...
db_host => 'mysqlserver.local',
db_name => 'owncloud',
db_user => 'owncloud',
db_pass => 'p4ssw0rd',
}
```
The ownCloud module does not install or configure the database server itself, this would need to be deployed by manually or, for example, with something similar to:
```puppet
class { '::mysql::server':
override_options => {
'mysqld' => { 'bind-address' => '0.0.0.0' }
},
restart => true,
root_password => 'sup3rt0ps3cr3t',
}
```
When $db_host is not set to 'localhost', the web server will export any mysql:db resources for a database server to collect. To collect these exported databases, include the following simple wrapper class on your MySQL server:
```puppet
include '::owncloud::database'
```
A complete example with with database installed on a different server would look like:
```puppet
node 'mysqlserver.local' {
class { '::mysql::server':
override_options => {
'mysqld' => { 'bind-address' => '0.0.0.0' }
},
restart => true,
root_password => 'sup3rt0ps3cr3t',
}
include '::owncloud::database'
}
node 'webserver.local' {
class { '::owncloud':
...
db_host => 'mysqlserver.local',
db_name => 'owncloud',
db_user => 'owncloud',
db_pass => 'p4ssw0rd',
}
}
```
#### Install and configure Apache to use SSL
To configure the Apache vhost to use SSL, you need to set `ssl` to `true` and define the absolute paths for the `ssl_cert` and `ssl_key` parameters. This module does not distribute certificate or key files to the server, you will need to take care of this yourself.
```puppet
class { '::owncloud':
...
ssl => true,
ssl_cert => '/path/to/file.crt',
ssl_key => '/path/to/file.key',
}
```
When configured to use SSL, any non HTTPS traffic to the HTTP port (defaults to 80) will be redirected to the HTTPS port (defaults to 443).
#### Install and manage only ownCloud
To install and configure ownCloud with no additional modules:
```puppet
class { '::owncloud':
...
manage_apache => false,
manage_db => false,
manage_vhost => false,
}
```
Deploying your web server with this configuration will result in:
* ownCloud repository added to your system
* ownCloud package installed (with any absent dependencies, such as Apache, PHP modules, etc.)
* ownCloud auto configured and ready for access on http://$default_vhost/owncloud
## Usage
### The `owncloud` class
The `owncloud` class configures all possible options for this module. With default parameters it will
* create the required database (either locally or export the `mysql::db` resource to be collected later on the database server (using `include ::owncloud::database`))
* install Apache and configure a vhost (either HTTP or HTTP and HTTPS)
* install the ownCloud application using the autoconfigure method
#### Parameters
##### `admin_pass`
Optionally set the admin password in the ownCloud configuration.
##### `admin_user`
Optionally set the admin user in the ownCloud configuration (using `admin_pass` as the password). If not set, OwnCloud will ask for admin credentials upon first connection.
##### `datadirectory`
Sets the directory user data will be stored in. It is not recommended to keep this in the default location (as a sub directory of the application document root) and it should be moved out of the document root before making your ownCloud instance accessible via the internet. Defaults to `/var/www/owncloud/data` on Debian based systems and `/var/www/html/owncloud/data` on RedHat based systems.
##### `db_host`
Sets the database server that ownCloud should use. If this is not 'localhost' and `manage_db` is set to true, the module will publish the `mysql:db` resource for collection by another node (typically your database server, collecting with `Mysql::Db <<| tag == 'owncloud' |>>`, if using the [PuppetLabs MySQL module](https://github.com/puppetlabs/puppetlabs-mysql)). Defaults to 'localhost'.
##### `db_name`
Set the database name in the ownCloud configuration and the database to create if `manage_db` is set to true. Defaults to 'owncloud'.
##### `db_table_prefix`
Set the database table prefix in the ownCloud configuration. Defaults to ''.
##### `db_user`
Set the database user in the ownCloud configuration and the database user to create (using `db_pass` as the password) if `manage_db` is set to true. Defaults to 'owncloud'.
##### `db_pass`
Set the database password in the ownCloud configuration. Defaults to 'owncloud'.
##### `db_type`
Set the database type in the ownCloud configuration. Currently the only supported backend database is MySQL. Defaults to 'mysql'.
##### `http_port`
Set the HTTP port to a non standard port. Defaults to '80'.
##### `https_port`
Set the HTTPS port to a non standard port. Defaults to '443'.
##### `manage_apache`
Set to true for the module to install Apache using the [PuppetLabs Apache module](https://github.com/puppetlabs/puppetlabs-apache). Typically this is managed elsewhere in your node definition, but if you are installing ownCloud on a dedicated webserver then setting `manage_apache` to true will configure Apache as required. Defaults to 'true'.
##### `manage_db`
Set to true for the module to create the database and database user for you, using the `db_name`, `db_user`, `db_pass` and `db_type` values. Enabling this will not install the database server, this must be done separately. Defaults to 'true'.
##### `manage_php`
Set to true for the module to install and configure PHP server-side components and modules required for ownCloud. Defaults to 'true'.
##### `manage_repo`
Set to true for the module to install the official ownCloud repository. Defaults to 'true'.
##### `manage_skeleton`
Set to true for the module to manage the skeleton directory. This is could be a feature in the future, but for the moment this removes the demo files from the skeleton directory in `${documentroot}/core/skeleton/{documents,music,photo}`. Defaults to 'true'.
##### `manage_vhost`
Set to true for the module to install the Apache virtual host using the [PuppetLabs Apache module](https://github.com/puppetlabs/puppetlabs-apache). It is possible to have `manage_apache` set to false and `manage_vhost` set to true to only install the vhost if you manage Apache separately. Defaults to 'true'.
##### `php_modules`
Specify the PHP module package names to install additional PHP modules; adding new ownCloud plug-ins may require additional PHP modules to be installed.
##### `ssl`
Set to true to enable HTTPS. When enabled, HTTP requests will be redirected to HTTPS. Must at least set the `ssl_cert` and `ssl_key` parameters to use SSL. Defaults to 'false'.
##### `ssl_ca`
Set the path of the CA certificate file, must use the absolute path.
##### `ssl_cert`
Set the path of the certificate file, must use the absolute path.
##### `ssl_chain`
Set the path of the certificate chain file, must use the absolute path.
##### `ssl_cipher`
Specify the Apache SSL Ciphers to use. See the [Apache Docs](http://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslciphersuite) for more details.
Defaults to `ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:ECDHE-RSA-DES-CBC3-SHA:ECDHE-ECDSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA`.
##### `ssl_key`
Set the path of the certificate key file, must use the absolute path.
##### `ssl_protocol`
Set the Apache SSL Protocols for SSL / TLS versions. See the [Apache Docs](http://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslprotocol) for more details.
Defaults to `all -SSLv2 -SSLv3`.
##### `trusted_domains`
Optional array to set the default trusted domains for OwnCloud. Use domain names without protocol. Default is unset, which will take the first domain used to connect to OwnCloud as a trusted domain name.
##### `url`
Configures the virtual host to install if `manage_apache` or `manage_vhost` are set to true. At this time there is no support for Apache server aliases. Defaults to `owncloud.${::domain}`
## Reference
### Classes
#### Public Classes
* `owncloud`: Guides the installation of ownCloud (including database creation and user data directory if specified).
* `owncloud::database`: Installs the ownCloud database; include this on your database server if it is separate to the web server (not required if database and application run on same server).
#### Private Classes
* `owncloud::apache`: Installs and configures Apache when `manage_apache` is set to `true`.
* `owncloud::config`: Configures ownCloud using autoconfig.php (and creates/exports a database).
* `owncloud::install`: Installs ownCloud (using the ownCloud repository).
* `owncloud::params`: Manages ownCloud operating system specific parameters.
## Limitations
* This module does not install a database server. An example has been provided on how to do this using [PuppetLabs MySQL module](https://github.com/puppetlabs/puppetlabs-mysql).
* This module has been tested on the following Operating Systems:
* CentOS 6
* CentOS 7
* Debian 7
* Debian 8
* Ubuntu 14.04 Trusty
## Development
At this time only one instance of ownCloud can be configured per host. It would be easy enough to change to a define to make a multi-tenant ownCloud server, but wasn't a requirement when writing this and can only see this being implemented if someone wants to add this functionality via a pull request.
Pull requests are welcome, please see the [contributing guidelines](https://github.com/shoekstra/puppet-owncloud/blob/develop/CONTRIBUTING.md).