-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathget_started.html
145 lines (125 loc) · 4.55 KB
/
get_started.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<link href='https://fonts.googleapis.com/css?family=Chivo:900' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="/stylesheets/stylesheet.css" media="screen" />
<link rel="stylesheet" type="text/css" href="/stylesheets/pygment_trac.css" media="screen" />
<link rel="stylesheet" type="text/css" href="/stylesheets/print.css" media="print" />
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>tpkg: Application packaging and deployment</title>
</head>
<body>
<div id="container">
<div class="sidebar">
<strong>Documents:</strong>
<ul>
<li><a href="get_started.html">Get started</a></li>
<li><a href="configure.html">Configure</a></li>
<li><a href="package.html">Package</a></li>
<li><a href="third_party.html">Package 3rd party apps</a></li>
<li><a href="deploy.html">Deploy</a></li>
<li><a href="package_server.html">Package server</a></li>
<li><a href="reporting_server.html">Reporting server</a></li>
<li><a href="production.html">Production</a></li>
<li><a href="externals.html">Externals</a></li>
<li><a href="faq.html">FAQ</a></li>
<li><a href="develop/">Develop</a></li>
</ul>
</div>
<div class="center">
<div class="inner">
<header>
<h1>tpkg</h1>
<h2>Application packaging and deployment</h2>
</header>
<hr>
<section id="main_content">
<p>
Here are the basic steps to getting a development copy of tpkg up and running.
Once you're ready to progress to a production-grade install see our
<a href="production.html">production setup</a> page.
</p>
<h2>Client</h2>
<h3>Via RubyGems</h3>
<p>
Our recommended installation process is via RubyGems:
</p>
<p>
<tt>gem install tpkg</tt>
</p>
<h3>MacPorts</h3>
<p>
On a Mac the MacPorts system provides an alternative easy installation:
</p>
<p>
<tt>port install tpkg</tt>
</p>
<h3>The Hard Way</h3>
<p>
If you'd prefer, you can download the tpkg source tarball and run from there.
</p>
<p>
<a href="https://github.com/tpkg/client/downloads">Download tpkg</a> and unpack it.
</p>
<p>
If you add the client directory to your PATH you can run tpkg without
installing it. Since you're running the client without building and installing
the client package you'll have to resolve dependencies manually for now. The
client depends on the
<a href="http://www.reductivelabs.com/projects/facter/">facter</a> library.
This
<a href="http://reductivelabs.com/trac/puppet/wiki/DownloadingPuppet">page</a>
has links to facter packages for a variety of platforms. If you have Ruby Gems
you can install facter with <tt>gem install facter</tt>.
</p>
<h2>Configuration</h2>
<p>
Tpkg will use /opt/tpkg as the base directory by default, which is where it
will install relocatable packages and store its own state. If you want to test
out tpkg without root privileges you can create ~/.tpkg.conf:
</p>
<pre>
base = /home/you/tpkgbase</pre>
<h2 id="DemoPackage">Demo Package</h2>
<p>
Here are some instructions for making up a quick package and installing it.
</p>
<ul>
<li><tt>mkdir /tmp/demopkg</tt></li>
<li>Create /tmp/demopkg/tpkg.yml:
<pre>name: demopkg
version: 1.0
maintainer: Nobody
description: Some description</pre></li>
<li><tt>mkdir /tmp/demopkg/reloc</tt></li>
<li><tt>touch /tmp/demopkg/reloc/demofile</tt></li>
<li><tt>tpkg --make /tmp/demopkg</tt></li>
<li><tt>tpkg --install /tmp/demopkg-1.0.tpkg</tt></li>
<li><tt>rm -rf /tmp/demopkg /tmp/demopkg-1.0.tpkg</tt></li>
</ul>
<p>
The install should have created /home/you/tpkgbase/demofile.
<tt>tpkg --qa</tt> should list the package as installed,
<tt>tpkg --ql demopkg</tt> should list the files in the package, etc.
Experiment with more complex packages, check out the
<a href="package.html">packaging documentation</a> page for more info, or
consult the pkgs directory in the distribution for scripts which build
complete packages of common applications like Perl, Ruby, etc.
</p>
<p>
To see what other tpkg operations are available, please consult the man page
or use the tpkg -h command.
</p>
</section>
</div>
</div>
<section id="downloads" class="clearfix">
<a href="https://github.com/tpkg" id="view-on-github" class="button"><span>View on GitHub</span></a>
</section>
</div>
</body>
</html>