Merge lp:~jose/charms/precise/vsftpd/fix-readme into lp:charms/vsftpd

Proposed by José Antonio Rey
Status: Merged
Merged at revision: 15
Proposed branch: lp:~jose/charms/precise/vsftpd/fix-readme
Merge into: lp:charms/vsftpd
Diff against target: 100 lines (+49/-42)
2 files modified
README (+0/-42)
README.md (+49/-0)
To merge this branch: bzr merge lp:~jose/charms/precise/vsftpd/fix-readme
Reviewer Review Type Date Requested Status
Marco Ceppi (community) Approve
Review via email: mp+215982@code.launchpad.net

Commit message

Converted README to Markdown

Description of the change

Converted README to Markdown

To post a comment you must log in.
Revision history for this message
Marco Ceppi (marcoceppi) wrote :

LGTM +1

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== removed file 'README'
--- README 2012-05-03 23:38:59 +0000
+++ README 1970-01-01 00:00:00 +0000
@@ -1,42 +0,0 @@
1Juju charm vsftpd
2author: Nathan Williams <nathan@nathanewilliams.com>
3
41. Setup your parameters in vsftpd.yaml
5> vi vsftpd.yaml
6 a list of settable parameters is available usering
7> juju get vsftpd
8or listing config.yaml
9
102. Deploying vsftpd
11> juju bootstrap
12> juju deploy --config vsftpd.yaml vsftpd
13> juju expose vsftpd
14
153. To find out the public address of vsftpd, browse
16 the output of the 'juju status' command.
17
18By default, the standard ftp port, 21, is turned on,
19this is changeable through the config value: "port".
20
21When a relation is joined, a user for each juju unit
22is created and has relation parameters generated for
23ftp_user, and ftp_passwd. The active port and server
24are also available in the relation details.
25
26The "delete_departed" config option controls whether
27to remove files belonging to users who have left the
28relation to the ftp-server.
29
30If you decide to enable anonymous access, be aware
31that the anonymous user, while not able to upload,
32will be able to browse and download files in any
33users home directory.
34
35Note that due to vsftpd security settings, it is not
36possible for users to upload files to their chroot'd
37home directory. Rather, each user has a folder "ftp"
38created within their chroot'd home folder which they
39can up/download to.
40
41For additional configuration options, see:
42https://help.ubuntu.com/12.04/serverguide/ftp-server.html#vsftpd-ftp-server-installation
430
=== added file 'README.md'
--- README.md 1970-01-01 00:00:00 +0000
+++ README.md 2014-04-15 22:48:00 +0000
@@ -0,0 +1,49 @@
1Juju charm vsftpd
2Author: Nathan Williams <nathan@nathanewilliams.com>
3
4# Usage
5
6Deploying vsftpd
7
8 juju bootstrap
9 juju deploy --config vsftpd.yaml vsftpd
10 juju expose vsftpd
11
12To find out the public address of vsftpd, browse the output of the `juju status`
13command.
14
15# Configuration
16
17Setup your parameters in vsftpd.yaml:
18
19 vi vsftpd.yaml
20
21A list of settable parameters is available using
22
23 juju get vsftpd
24
25or listing config.yaml
26
27By default, the standard ftp port, 21, is turned on, this is changeable through
28the config value: "port".
29
30The "delete_departed" config option controls whether to remove files belonging
31to users who have left the relation to the ftp-server.
32
33If you decide to enable anonymous access, be aware that the anonymous user,
34while not able to upload, will be able to browse and download files in any users
35home directory.
36
37Note that due to vsftpd security settings, it is not possible for users to
38upload files to their chroot'd home directory. Rather, each user has a folder
39"ftp" created within their chroot'd home folder which they can up/download to.
40
41# Relations
42
43When a relation is joined, a user for each juju unit is created and has relation
44parameters generated for ftp_user, and ftp_passwd. The active port and server
45are also available in the relation details.
46
47# More Info
48
49For additional configuration options, see [Ubuntu's FTP Server help page](https://help.ubuntu.com/12.04/serverguide/ftp-server.html#vsftpd-ftp-server-installation)

Subscribers

People subscribed via source and target branches