X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=d5f35a41a593591f2a5c4820d4f728778fdce29e;hb=7d47df8425792ff76e469259242c0d57011bc244;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=c1600c35da65fad1262333672f1ea4485458ed50;p=routeros-api.git diff --git a/README b/README index e69de29..d5f35a4 100644 --- a/README +++ b/README @@ -0,0 +1,62 @@ +librouteros +=========== + + librouteros is a library to communicate with RouterOS, the operating system +of MikroTik's RouterBoards. It uses the “API port” provided by those systems to +connect and talk to the devices. librouteros is a low-level library in that it +abstracts the network protocol used but has next to no knowledge about the +commands and responses available. Should such an high-level interface prove +useful, it will be added as the need arises. + + +Dependencies +------------ + + The RouterOS API uses a simple challenge-response authentication schema using +cryptographically secure MD5 hashes. The library used for MD5 computation is +“gcrypt”, a cryptographic library originally written for the GnuPG project. + + +Enabling API connections +------------------------ + + API connections (sometimes also called “Winbox connections”) must be +explicitly enabled. To do so, issue the following command: + + /ip service enable api + +To allow a specific user / group to use the API, the “winbox” item must be +added to the user's “policy” in “/user group”. + + +Contact +------- + + There's currently no mailing list available for librouteros. In case of +questions, suggestions and feedback in general, please contact the author +directly (see “Author” below). + + +License +------- + + librouteros is licensed under the terms of the GNU General Public License, +version 2 (GPLv2). + + +See also +-------- + + Information about MikroTik and RouterOS can be found on MikroTik's homepage, +. The API documentation used to write this library is +available from . + + +Author +------ + + librouteros was originally written in 2009 by Florian Forster. + and released under the terms of the General Public +License, version 2 (GPLv2). + +Additional contributors are listed in the file called `AUTHORS'.