You are here: Home > Manage IPs and ASNs > RIPE Database > Database Support > RIPE Database Documents > RIPE Database Documentation > 1. Introduction to the RIPE Database

Introduction to the RIPE Database

1.1 RIPE Database Documentation Overview

This is the starting point for information about the RIPE Database. Everything that you need to know to use the RIPE Database will be described within these pages. If anything is missing or unclear, please contact us and we will do our best to help.

The format of this documentation is a Master Index with headings and sub-headings. Each of these (sub-)headings links to a separate web page. This web page may be an index page to a series of other web pages. This documentation explains the RIPE Database in a large collection of small documents on specific topics with a comprehensive index so that the information is easy to find.

There is a Glossary of Terms and Definitions that explains the meaning of commonly used terminology, phrases, words and acronyms related to the RIPE Database. There is also a set of references to other articles, standards and agreements relating to the RIPE Database.

There is a strong relationship between the full set of documentation and software releases. With every new release, the whole set of documents will be updated to reflect the changes in the software. The previous sets of documentation will still be available to view online or download as a PDF document.

These documents describe the technical features of the RIPE Database and how to use it. For a full explanation of why the RIPE Database works the way it does you may need to refer to the relevant RIPE Documents.

1.2 Intended Audience

This documentation has been written for both casual and experienced users of the RIPE Database. This documentation assumes a basic knowledge of computing. It also covers more technical aspects for users who wish to run their own local instance of the RIPE Database software.

1.3 Conventions Used in the RIPE Database Documentation

The following conventions are used:

  • <label> indicates a placeholder or syntax.
  • [option] indicates optional text or command argument.
  • bold font indicates an object type.
  • “attribute:” indicates an attribute of an object.
  • ‘value' indicates the value of an attribute.

The term “RIPE Database” is used in several ways depending on the context. It may mean the:

  • Entire service
  • Database software
  • Interface
  • Logical database
  • Database contents

Where there is any doubt, we will clarify what is being discussed.

This documentation is in draft status.
Please send any feedback or feature requests to ripe-dbm@ripe.net.