root
/
fpm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
fpm/docs/installing.rst

97 lines
3.1 KiB
ReStructuredText
Raw Permalink Normal View History

Start working on some better fpm documentation. This time is using Sphinx and reST. To build: `make build` The docs will appear in docs/_build/html/
2016-11-20 04:18:35 +08:00
Installation
============
FPM requires a few things before you can use it. This document will show you
how to install all the necessary things :)
Depending on what you want to do with FPM, you might need some extra things installed (like tooling to build rpms, or solaris packages, or something else), but for now, let's just get ruby so we can start using fpm!
Installing things FPM needs
--------------
.. warning::
This section may be imperfect due to the inconsistencies across OS vendors
fpm is written in Ruby, you'll need to provide Ruby. Some operating systems,
slight grammer and typo
2016-12-05 16:55:54 +08:00
like OSX, come with Ruby already, but some do not. Depending on your operating system, you might need to run the following commands:
Start working on some better fpm documentation. This time is using Sphinx and reST. To build: `make build` The docs will appear in docs/_build/html/
2016-11-20 04:18:35 +08:00
On OSX/macOS::
slight grammer and typo
2016-12-05 16:55:54 +08:00
brew install gnu-tar
Start working on some better fpm documentation. This time is using Sphinx and reST. To build: `make build` The docs will appear in docs/_build/html/
2016-11-20 04:18:35 +08:00
On Red Hat systems (Fedora 22 or older, CentOS, etc)::
Add rubygems to CentOS install line (#1309) For CentOS7, I needed to install rubygems. Not sure if it is included in e.g. ruby-devel for previous versions?
2017-06-03 06:55:14 +08:00
yum install ruby-devel gcc make rpm-build rubygems
Start working on some better fpm documentation. This time is using Sphinx and reST. To build: `make build` The docs will appear in docs/_build/html/
2016-11-20 04:18:35 +08:00
On Fedora 23 or newer::
Add libffi-devel to fedora 23+ install step. (#1352) Fixes #1351
2017-06-15 13:04:20 +08:00
dnf install ruby-devel gcc make rpm-build libffi-devel
Start working on some better fpm documentation. This time is using Sphinx and reST. To build: `make build` The docs will appear in docs/_build/html/
2016-11-20 04:18:35 +08:00
This improves the Oracle Linux install docs by removing the additional repo that was added and enabling the ol7_optional_latest repo instead. This ensures that fully supported packages are installed, including the ruby-devel package. This also corrects the product name. Signed-off-by: Avi Miller <avi.miller@oracle.com>
2019-05-02 04:50:49 +08:00
On Oracle Linux 7.x systems::
Updated docs/installing.rst to reflect Oracle Enteprise Linux instructions
2019-02-06 03:54:35 +08:00
This improves the Oracle Linux install docs by removing the additional repo that was added and enabling the ol7_optional_latest repo instead. This ensures that fully supported packages are installed, including the ruby-devel package. This also corrects the product name. Signed-off-by: Avi Miller <avi.miller@oracle.com>
2019-05-02 04:50:49 +08:00
yum-config-manager --enable ol7_optional_latest
Updated docs/installing.rst to reflect Oracle Enteprise Linux instructions
2019-02-06 03:54:35 +08:00
yum install ruby-devel gcc make rpm-build rubygems
Start working on some better fpm documentation. This time is using Sphinx and reST. To build: `make build` The docs will appear in docs/_build/html/
2016-11-20 04:18:35 +08:00
On Debian-derived systems (Debian, Ubuntu, etc)::
docs/installing: Fix build deps on Debian-derived systems (#1321)
2017-04-08 05:51:18 +08:00
apt-get install ruby ruby-dev rubygems build-essential
Start working on some better fpm documentation. This time is using Sphinx and reST. To build: `make build` The docs will appear in docs/_build/html/
2016-11-20 04:18:35 +08:00
Installing FPM
--------------
You can install fpm with the `gem` tool::
Update outdated "gem install" command The --no-ri and --no-rdoc switches have now been superseded by --no-document per https://guides.rubygems.org/command-reference/#gem_install
2019-11-16 19:15:52 +08:00
gem install --no-document fpm
Start working on some better fpm documentation. This time is using Sphinx and reST. To build: `make build` The docs will appear in docs/_build/html/
2016-11-20 04:18:35 +08:00
.. note::
`gem` is a command provided by a the Ruby packaging system called `rubygems`_. This allows you to install, and later upgrade, fpm.
.. _rubygems: https://en.wikipedia.org/wiki/RubyGems
You should see output that looks like this::
% gem install --no-ri --no-rdoc fpm
Fetching: cabin-0.9.0.gem (100%)
Successfully installed cabin-0.9.0
Fetching: backports-3.6.8.gem (100%)
Successfully installed backports-3.6.8
Fetching: arr-pm-0.0.10.gem (100%)
Successfully installed arr-pm-0.0.10
Fetching: clamp-1.0.1.gem (100%)
Successfully installed clamp-1.0.1
Fetching: ffi-1.9.14.gem (100%)
Building native extensions. This could take a while...
Successfully installed ffi-1.9.14
Fetching: childprocess-0.5.9.gem (100%)
Successfully installed childprocess-0.5.9
Fetching: archive-tar-minitar-0.5.2.gem (100%)
Successfully installed archive-tar-minitar-0.5.2
Fetching: io-like-0.3.0.gem (100%)
Successfully installed io-like-0.3.0
Fetching: ruby-xz-0.2.3.gem (100%)
Successfully installed ruby-xz-0.2.3
Fetching: dotenv-2.1.1.gem (100%)
Successfully installed dotenv-2.1.1
Fetching: insist-1.0.0.gem (100%)
Successfully installed insist-1.0.0
Fetching: mustache-0.99.8.gem (100%)
Successfully installed mustache-0.99.8
Fetching: stud-0.0.22.gem (100%)
Successfully installed stud-0.0.22
Fetching: pleaserun-0.0.27.gem (100%)
Successfully installed pleaserun-0.0.27
Fetching: fpm-1.6.3.gem (100%)
Successfully installed fpm-1.6.3
15 gems installed
Now you should be ready to use fpm!
To make sure fpm is installed correctly, try running the following command::
fpm --version
You should get some output like this, although the exact output will depend on which version of fpm you have installed.::
% fpm --version
1.6.3