Skip to content

Commit

Permalink
Included user-agent docs and added Debian status
Browse files Browse the repository at this point in the history
  • Loading branch information
danielquinn committed Dec 15, 2015
1 parent ac3f481 commit 31e827c
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 2 deletions.
12 changes: 10 additions & 2 deletions PACKAGING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,28 @@ happen faster, please direct your efforts to the bug in question. Until then
you can always just use Daniel's overlay right from GitHub.


## Debian

* Apollon Oikonomopoulos

### Status

Apollon is working with the RIPE Atlas team to ensure that the package conforms
to Debian standards and has volunteered to submit everything once it's ready.


## Other Platforms

We've been talking with members of the community about expanding the package
support for Magellan, but so far no one has officially volunteered. The RIPE
Atlas team is happy to assist anyone interested in porting this toolkit to any
platform, but we're especially keen on at least getting into:

* Debian
* Ubuntu
* Red Hat
* Fedora
* CentOS
* Arch
* FreeBSD

If you'd like to try your hand, or would simply like to offer some advice, feel
free to add your name here or contact us directly via *atlas at ripe dot net*.
47 changes: 47 additions & 0 deletions docs/packaging.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
Packaging
=========

For those interested in packaging RIPE Atlas Tools for their favourite distro,
this section is for you.

Currently Supported
-------------------

* OpenBSD
* FreeBSD

In Progress
-----------

* `Gentoo Linux`_: Daniel Quinn has an `overlay`_ in development.
* `Debian Linux`_: Apollon Oikonomopoulos is working with the RIPE Atlas team to
ensure that everything conforms to Debian standards.

.. _`Gentoo Linux`: https://gentoo.org/
.. _`overlay`: https://github.com/danielquinn/ripe-atlas-overlay
.. _`Debian Linux`: https://www.debian.org/

Additional Distributions
------------------------

Is your distribution not listed? If you'd like to build a package for another
distro or even if you're just someone who knows someone who can help us package
and distribute this, please get in touch.

Further Information
-------------------

User Agent
~~~~~~~~~~

When packaging, it's good practise to manually set the user agent used within
the toolkit so that we can get a rough idea of which distros are using this
software. This is easily done by writing an arbitrary string to
``<root>/ripe/atlas/tools/user-agent``. Something like this is recommended:::

RIPE Atlas Tools (Magellan) [FreeBSD 10.2] 1.2

The only limitations to this file are that it should:

* Only have one line in it (all other will be ignored)
* That line should have a maximum of 128 characters in it

0 comments on commit 31e827c

Please sign in to comment.