~jose/charms/precise/owncloud/port-change+repo+ssl-support

23 by Jorge O. Castro
Fix formatting for commands.
1
# OwnCloud
2
40 by José Antonio Rey
Updated the author's email address
3
- Author: Atul Jha <koolhead17@gmail.com>
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
4
- Maintainer: José Antonio Rey <jose@ubuntu.com>
19.2.1 by Charles Butler
Moves README to a markdown file with formatting
5
19.2.3 by Charles Butler
Expands on the charm doing description in readme
6
# Overview
7
23.1.2 by José Antonio Rey
Added note on README
8
ownCloud provides universal access to your files via the web, your computer or
9
your mobile devices — wherever you are. It also provides a platform to easily
10
view & sync your contacts, calendars and bookmarks across all your devices and
11
enables basic editing right on the web.
19.2.3 by Charles Butler
Expands on the charm doing description in readme
12
23.1.2 by José Antonio Rey
Added note on README
13
This charm installs Apache2, Apache-Mod-PHP5, and configures OwnCloud with
14
sqlite as a standalone server. Provides relationship hooks with NFS file
15
storage, MySQL Databases, and HAProxy reverse proxy charms.
19.2.3 by Charles Butler
Expands on the charm doing description in readme
16
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
17
# Configuration
18
42 by José Antonio Rey
Updated README, fixed idempotency on src option
19
This charm comes with different configuration options. Optional configuration
20
options include:
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
21
22
`domain`: This is the domain or IP address for your ownCloud instance. If you
31 by José Antonio Rey
Fixed README and added default 'not configured' page
23
do not know what it is, execute `juju status` to find out the public address. If
24
not provided, the charm will refuse to configure.
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
25
42 by José Antonio Rey
Updated README, fixed idempotency on src option
26
`downloadurl`: This is the download URL that the charm will use in case the src
27
option is set to `source`. It defaults to the 6.0.4 URL.
28
29
`sha1sum`: This is the SHA1SUM for the `downloadurl` file. It defaults to the
30
SHA1SUM for the 6.0.4 file.
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
31
32
`port`: This is the alias port that will be used for the ownCloud instance. It
33
will redirect to 443, which is the HTTPS port. It defaults to 80.
34
35
`src`: This is the source from which the package will be installed. You can
36
choose between `repo`, which will install it from a repository built by
37
ownCloud, or `source`, which will download the tarball and extract it. It
38
defaults to `repo`.
39
40
`customssl`: This charm provides default SSL support for ownCloud. This means
41
that if you do not provide a custom SSL key and certificate, a self-signed one
42
will be auto-generated for you. If you want to use a custom SSL certificate,
43
please set this option to `true`. It defaults to `false`.
44
45
`sslkey`: If `customssl` is set to true, this is the SSL key that will be used.
46
If not provided and `customssl` is true, the charm will refuse to configure.
47
48
`sslcert`: If `customssl` is set to true, this is the SSL cert that will be
49
used. If not provided and `customssl` is true, the charm will refuse to
50
configure.
51
52
`user`: This user will be used in case you want to do a setup of Shared
53
Instances. If not provided, it will be defaulted to `ownCloud`.
54
31 by José Antonio Rey
Fixed README and added default 'not configured' page
55
`password`: This password will be used in case you want to do a setup of
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
56
Shared Instances. If not provided, it will be randomly generated when a DB
57
relation is joined.
58
59
You can put any of this options in a config.yaml file and specify it at the
60
moment of deploying. Otherwise, you can change them by executing:
61
62
    juju set owncloud [option]=[value]
63
64
# Usage
65
66
## Standalone Instance
67
68
First, bootstrap your environment:
69
70
    juju bootstrap
71
72
Then, deploy ownCloud by executing the following command:
23 by Jorge O. Castro
Fix formatting for commands.
73
    
74
    juju deploy owncloud
19.2.1 by Charles Butler
Moves README to a markdown file with formatting
75
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
76
Finally, expose the service:
19.2.1 by Charles Butler
Moves README to a markdown file with formatting
77
23 by Jorge O. Castro
Fix formatting for commands.
78
    juju expose owncloud
19.2.1 by Charles Butler
Moves README to a markdown file with formatting
79
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
80
Access OwnCloud service directly, and complete the setup, providing user
81
credentials and initializing sqlite database.
82
83
## Shared Instances
84
85
If you want to deploy shared instances, execute the following commands after
86
doing a Standalone Instance setup:
19.2.1 by Charles Butler
Moves README to a markdown file with formatting
87
23 by Jorge O. Castro
Fix formatting for commands.
88
    juju deploy mysql
89
    juju add-relation mysql owncloud
19.2.1 by Charles Butler
Moves README to a markdown file with formatting
90
23 by Jorge O. Castro
Fix formatting for commands.
91
    juju deploy nfs
92
    juju add-relation nfs owncloud
19.2.1 by Charles Butler
Moves README to a markdown file with formatting
93
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
94
We're now done! To find out the address for your ownCloud instance, execute
95
`juju status` and navigate to it.
96
97
# Scale out Usage
98
99
In order to do a scalabe deploy of ownCloud, execute the following commands
100
101
    juju bootstrap
19.2.3 by Charles Butler
Expands on the charm doing description in readme
102
    juju deploy owncloud
103
    juju deploy mysql
104
    juju deploy haproxy
105
    juju add-relation mysql owncloud
106
    juju add-relation haproxy owncloud
107
    juju add-unit owncloud
108
38 by José Antonio Rey
Fixed various bugs
109
# Internet Connection Requirements
110
111
This charm downloads files from the Internet, and requires Internet connectivity
112
in order to properly install. The requirements vary for each setup type.
113
114
## When installing from the source
115
116
When installing from the source packages available for download, this charm will
117
connect to the following Internet sites:
118
119
 * download.owncloud.org with port 443
120
 * The Ubuntu repositories or a private mirror of them
121
122
## When installing from the repository
123
124
ownCloud offers the option to install from a repository. This is the default
125
configuration value for the charm. With this, the charm will connect to the
126
following Internet sites:
127
128
 * download.opensuse.org with port 80
129
 * download.opensuse.org as a repository
130
 * The Ubuntu repositories or a private mirror of them
19.2.3 by Charles Butler
Expands on the charm doing description in readme
131
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
132
# Known Limitations
23.1.2 by José Antonio Rey
Added note on README
133
134
If you have been using a standalone instance and want to migrate to a shared
135
instance, please note that adding the mysql relation will not preserve the file
136
structure in the database. This means that your file listing will not be
137
available. Make sure to have this in mind when doing the migration.
138
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
139
Also, if you leave the `customssl` option set to false or provide a self-signed
140
SSL certificate, ownCloud will throw a WebDAV error after creating the admin
141
username and password. Ignore this error as it does not affect the working of
142
ownCloud (it is silently fixed), and enter your website again.
143
38 by José Antonio Rey
Fixed various bugs
144
If port is different than 80, it looks like the instance throws an SSL
27 by José Antonio Rey
Re-written part of the README, added SSL support and taken maintainership of the charm
145
error when connecting. Recommendation is to set the `port` value to 80 to avoid
146
problems.
147
38 by José Antonio Rey
Fixed various bugs
148
Finally, on the tests side, the tests will fail on the local provider due to
149
NFS not being able to deploy correctly (this is an NFS-related issue).
150
19.2.1 by Charles Butler
Moves README to a markdown file with formatting
151
#TODO
152
Genericize shared-fs-relation-* for non-nfs shared-fs providers