Differences between revisions 28 and 30 (spanning 2 versions)
Revision 28 as of 2021-04-08 00:17:05
Size: 4027
Editor: ?Louis-PhilippeVeronneau
Comment: use https in the shell script
Revision 30 as of 2021-04-08 02:27:16
Size: 3617
Editor: PaulWise
Comment: typo
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
[[http://deb.li|deb.li]] is a shortURL service for Debian related usage, hosted and developed by BerndZeimetz. The service is also available under the domain [[http://go.debian.net|go.debian.net]]. To ensure that deb.li is not used by random spammers, adding new URLs is limited to a json-rpc web-interface for now, which is only accessible from a limited list of IPs. [[https://deb.li/|deb.li]] is a shortURL service for Debian related usage, hosted and developed by BerndZeimetz. The service is also available under the domain [[http://go.debian.net/|go.debian.net]]. To ensure that deb.li is not used by random spammers, adding new URLs is limited to a json-rpc web-interface for now, which is only accessible from a limited list of IPs.
Line 8: Line 8:
* '''How do I use deb.li??'''  * '''How do I use deb.li??'''
Line 12: Line 12:
# call me 'deb.li' and use me as 'deb.li http://some/long/url', stdout is a cut-and-paste friendly URL # call me 'deb.li' and use me as 'deb.li https://some/long/url', stdout is a cut-and-paste friendly URL
Line 30: Line 30:
  . Yes, you have up to 10 characters to create a made-up short URL, (e.g. the link can be http://deb.li/myshortURL but cannot be http://deb.li/myshortURL2 ) .   . Yes, you have up to 10 characters to create a made-up short URL, (e.g. the link can be https://deb.li/myshortURL but cannot be https://deb.li/myshortURL2 ) .
Line 36: Line 36:
  . An email-gateway is planned, but not implemented yet. It will accept gpg-signed control mails, similar to db.debian.org.   . An email-gateway is planned, but not implemented yet. It will accept OpenPGP signed control mails, similar to db.debian.org.
Line 42: Line 42:
  . Yes, just use [[http://deb.li/p/<key>]] instead of [[http://deb.li/<key>]].   . Yes, just use [[https://deb.li/p/<key>]] instead of [[https://deb.li/<key>]].
Line 55: Line 55:
  . Clone the git repository from [[git@github.com:bzed/go.debian.net-client.git]] or [[https://github.com/bzed/go.debian.net-client]] and read the [[https://github.com/bzed/go.debian.net-client/blob/master/README.md|README]]. Also there is a checked out version on master.debian.org - have a look into ''~pollo/godebian-client'' aka ''/home/users/pollo/godebian-client''.

 * '''I'd like to use deb.li ShortURLs in my CIA bot messages, is this possible?'''
  . Yes, sure. have a look at [[http://deb.li/ciabot|deb.li/ciabot]] - the ciabot.py script in the example client repository. Please note that the script is a bit customized for [[http://alioth.debian.org|alioth]], so make sure it works properly for you when you use it somewhere else.
  . Clone the git repository from [[https://github.com/bzed/go.debian.net-client]] and read the [[https://github.com/bzed/go.debian.net-client/blob/master/README.md|README]]. Also there is a checked out version on master.debian.org - have a look into ''~pollo/godebian-client'' aka ''/home/users/pollo/godebian-client''.
Line 61: Line 58:
The json-rpc URL is http://deb.li/rpc/json. The following functions are provided:
The json-rpc URL is https://deb.li/rpc/json. The following functions are provided:

deb.li - the Debian ShortURL service

deb.li is a shortURL service for Debian related usage, hosted and developed by BerndZeimetz. The service is also available under the domain go.debian.net. To ensure that deb.li is not used by random spammers, adding new URLs is limited to a json-rpc web-interface for now, which is only accessible from a limited list of IPs.

FAQ

  • How do I use deb.li??

    • The easiest way to use deb.li is to use the following script. Just put it in your /usr/local/bin:

      #!/bin/sh -e
      # call me 'deb.li' and use me as 'deb.li https://some/long/url', stdout is a cut-and-paste friendly URL
      echo "https://deb.li/$(ssh master.debian.org ~pollo/godebian-client/add_url "$@")"
  • Which hosts are allowed to access the json-rpc interface

    • 70.103.162.29 (master.debian.org)
    • 82.195.75.32/28, 82.195.75.64/26, 2001:41B8:202::/48 (Debian networks @ MAN-DA)
    • 192.25.206.16 (merkel.debian.org)
    • 93.94.130.128/26 (Debian network @ dg-i)
    • 206.12.19.0/24 (Debian network @ UBCECE)
    • 217.196.144.0/20, 2a02:16a8:dc41:100::/56 (Debian networks @ conova)
    • 194.177.211.192/27 (Debian network @ GRNET)
    • 206.12.19.123, 2607:f8f0:610:4000:216:36ff:fe40:3861 (nono.debian.org)
  • I'd like to add new URLs from a different host

  • Is there a character limit for the made-up short URLs?

  • Is it ok to add a huge amount of URLs automatically

    • Basically - yes. But please make sure it doesn't end up in DOSing the service. It is appreciated if you would contact BerndZeimetz (bzed@debian.org) before adding a huge amount of URLs, maybe there is a faster and/or better way than the json-rpc interface.

  • Will there be other ways to add URLs to the service?

    • An email-gateway is planned, but not implemented yet. It will accept OpenPGP signed control mails, similar to db.debian.org.
  • Is there a bugtracker?

  • Is there a preview page of the short URLs available?

  • Where is the code?

  • Where is the documentation in the code?

    • Not yet written. Patches are welcome!
  • Is there an example JSON-RPC Client?

  • How do I use the example Client?

JSON-RPC API documentation

The json-rpc URL is https://deb.li/rpc/json. The following functions are provided:

  • add_url(url)

  • add_static_url(url, key)

  • update_static_url(url, key)

  • get_url(key)

url is the URL which should be shortened and key the key part of the short URL. Please note that the API is not declared as stable yet.