summaryrefslogtreecommitdiffstats
path: root/share/man/container-create-curl.1
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/container-create-curl.1')
-rw-r--r--share/man/container-create-curl.1165
1 files changed, 165 insertions, 0 deletions
diff --git a/share/man/container-create-curl.1 b/share/man/container-create-curl.1
new file mode 100644
index 0000000..a69522f
--- /dev/null
+++ b/share/man/container-create-curl.1
@@ -0,0 +1,165 @@
+'\" t
+.\" Title: container-create-curl
+.\" Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 20170701
+.\" Manual: Open Infrastructure
+.\" Source: container-tools
+.\" Language: English
+.\"
+.TH "CONTAINER\-CREATE\-C" "1" "20170701" "container\-tools" "Open Infrastructure"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+container-create-curl \- Create a Debian based container by downloading a tarball over the network
+.SH "SYNOPSIS"
+.sp
+\fBcontainer create \-s curl\fR [\fIOPTIONS\fR]
+.SH "DESCRIPTION"
+.sp
+The curl container creation script uses curl(1) to download a tarball over the network to create a Debian based container\&.
+.sp
+Depending on the tarball this script otherwise creates a pure Debian system with three modificiations:
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+hostname is set (container name) in /etc/hostname
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+systemd machine\-id is generated in /etc/machine\-id
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+root password is set (user specified or 16 random characters)
+.RE
+.SH "OPTIONS"
+.sp
+The following script options are available:
+.PP
+\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR
+.RS 4
+Specify container name\&.
+.RE
+.PP
+\fB\-a, \-\-architecture=\fR\fB\fIARCHITECTURE\fR\fR
+.RS 4
+Specify container architecture\&.
+.RE
+.PP
+"\-\-clean*
+.RS 4
+Remove downloaded tarball after successfull container creation\&.
+.RE
+.PP
+\fB\-p, \-\-root\-password=\fR\fB\fIPASSWORD\fR\fR
+.RS 4
+Specify the root password, defaults to a random 16 character password\&.
+.RE
+.PP
+\fB\-\-server=\fR\fB\fISERVER\fR\fR
+.RS 4
+Specify the image server to download from, defaults to
+https://files\&.open\-infrastructure\&.net/system/container/debian\&.
+.RE
+.PP
+\fB\-\-setup=\fR\fB\fISETUP\fR\fR
+.RS 4
+.RE
+.PP
+\fB\-\-system=\fR\fB\fISYSTEM\fR\fR
+.RS 4
+.RE
+.SH "EXAMPLES"
+.PP
+\fBCreate a Debian 9 (stretch) based container with same architecture as the host system:\fR
+.RS 4
+sudo container create \-s curl \-n stretch\&.example\&.net
+.RE
+.PP
+\fBCreate a Debian 9 (stretch) based container with different architecture as the host system:\fR
+.RS 4
+sudo container create \-s curl \-n stretch\-i386\&.example\&.net \(em \-\-system debian\-stretch\-current_i386\&.system\&.tar\&.xz
+.RE
+.SH "FILES"
+.sp
+The following files are used:
+.PP
+\fB/etc/container\-tools/config\fR
+.RS 4
+Container configuration files\&.
+.RE
+.PP
+\fB/usr/share/container\-tools/scripts\fR
+.RS 4
+Container creation scripts\&.
+.RE
+.PP
+\fB/usr/share/doc/container\-tools\fR
+.RS 4
+Container documentation\&.
+.RE
+.PP
+\fB/var/lib/machines\fR
+.RS 4
+Container directory\&.
+.RE
+.PP
+\fB/var/cache/container\-tools\fR
+.RS 4
+Container cache directory\&.
+.RE
+.SH "CONTAINER IMAGES"
+.sp
+container\-tools will download tarballs from a server expecting that the images are tarballs with either gzip, lzip, xz, or no compression\&. See container\-images\&.sh as an example on how to create your own container images\&.
+.SH "SEE ALSO"
+.sp
+container\-tools(7), container(1)\&.
+.SH "HOMEPAGE"
+.sp
+More information about container\-tools and the Open Infrastructure project can be found on the homepage at https://open\-infrastructure\&.net\&.
+.SH "CONTACT"
+.sp
+Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List <software@lists\&.open\-infrastructure\&.net>\&.
+.sp
+Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs\&.debian\&.org\&.
+.SH "AUTHORS"
+.sp
+container\-tools was written by Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net>\&.