Begin to write README
This commit is contained in:
parent
03b37c0a44
commit
69c55731db
31
README.rst
31
README.rst
|
@ -16,31 +16,20 @@ subdirectories (see below).
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
config
|
||||||
|
Name of the configuration file below files/openvpn/
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
state
|
srcdir
|
||||||
'present', 'absent', 'exists' or 'pre-exists', defaults to 'present' where:
|
Directory that contains additional files for the server
|
||||||
|
configuration. The directory is relative to files/openvpn/.
|
||||||
|
If not specified, defaults to "server-generic". This directory
|
||||||
|
contains usually the following files: ca.crt, server.crt and
|
||||||
|
server.key. Additionally a sub directory "ccd" can be present that
|
||||||
|
contains client specific configuration files.
|
||||||
|
|
||||||
present
|
|
||||||
the file is exactly the one from source
|
|
||||||
absent
|
|
||||||
the file does not exist
|
|
||||||
exists
|
|
||||||
the file from source but only if it doesn't already exist
|
|
||||||
pre-exists
|
|
||||||
check that the file exists and is a regular file, but do not
|
|
||||||
create or modify it
|
|
||||||
|
|
||||||
group
|
|
||||||
Group to chgrp to.
|
|
||||||
|
|
||||||
mode
|
|
||||||
Unix permissions, suitable for chmod.
|
|
||||||
|
|
||||||
owner
|
|
||||||
User to chown to.
|
|
||||||
|
|
||||||
source
|
source
|
||||||
If supplied, copy this file from the host running cdist to the target.
|
If supplied, copy this file from the host running cdist to the target.
|
||||||
|
|
21
manifest
21
manifest
|
@ -1,3 +1,24 @@
|
||||||
|
#!/bin/sh -e
|
||||||
|
#
|
||||||
|
# 2018 ungleich glarus ag (foss at ungleich.ch)
|
||||||
|
#
|
||||||
|
# This file is part of cdist.
|
||||||
|
#
|
||||||
|
# cdist is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
#
|
||||||
|
# cdist is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU General Public License
|
||||||
|
# along with cdist. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
config=$(cat "$__object/parameter/config")
|
config=$(cat "$__object/parameter/config")
|
||||||
|
|
||||||
srcdirparamfile="$__object/parameter/srcdir"
|
srcdirparamfile="$__object/parameter/srcdir"
|
||||||
|
|
Loading…
Reference in New Issue