Skip to content

Commit

Permalink
Initial import of README and basic Public Domain style license.
Browse files Browse the repository at this point in the history
  • Loading branch information
dotwaffle committed Jun 12, 2015
0 parents commit 370c0d4
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
24 changes: 24 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# So, You've Decided To Peer -- What Next?

This project seeks to make an easy to follow, concise publication on how to be a "good BGP citizen". This should include examples for as many "big vendor" routing platforms as possible, and be applicable to all BGP peering sessions (with the possible exception of transit).

It aims to cover:

* How to use max-prefix safely.
* How to generate / use prefix lists.
* How to generate / use as-path filters.
* How to implement BCP38 on your edge ports.
* How to implement RPKI, where applicable.

It will not cover:

* Edge cases.
* What BGP is, or what iBGP is.
* What peering is, or how to peer effectively.
* The history of peering.
* Good / Bad networks to peer with.
* BGP Path selection.
* BGP Communities, except with an IXP Route Server.

It should remain, where possible, without overly vendor specific features or mentions of particular products in isolation.

The expected deliverables are threefold:

1. An HTML guide, on readthedocs.org or similar.
2. A PDF (preferably in A4, A5, and US Letter sizes) for download.
3. A slide-deck for inclusion into Network Operator Group conferences.

It is likely that #3 will be created at a later date.

All submitted contributions to the main upstream source repository must be in source (preferably textual) form. If you choose to submit a binary (such as an image) it must be absent of all branding (commercial or otherwise) and be provided free of charge and subject only to the terms of the license of this documentation. You must have rights to the submitted material, and must be able to release into the Public Domain. This does not infringe on your right to fork this repository and produce your own derivative work.

0 comments on commit 370c0d4

Please sign in to comment.