Bootleg bot: Difference between revisions

From XPUB & Lens-Based wiki
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Networks==
''This page is prepared for the prototyping class on 3 March 2026 as part of SI29 and follows a Special Issue day with Doriane and Simon fully on topic of [[The bootleg library]].''


(we will go through the following commands from '''sergio''')
https://git.xpub.nl/kamo/bot-magic-words


To which networks is sergio connected right now?


ip a
==the zulip bot==


To which networks is the bootleg library connected right now?
First install the requirements listed on this page:
 
https://zulip.com/help/writing-bots
 
You can run the bot with:
 
zulip-run-bot --config-file bootlegbot.zuliprc bootlegbot.py
 
(or <code>uv run zulip-run-bot --config-file bootlegbot.zuliprc bootlegbot.py</code> if you are using uv)
 
===bootlegbot.py===
 
<syntaxhighlight lang="python">
class BootlegBot(object):
    '''
    This is a small zulip bot to interact with the 👢🦵 library
    '''
 
    def usage(self):
        return '''Ask the bot about a book and they will search for it in the 👢🦵 library'''
 
    def handle_message(self, message, bot_handler):
        # This happens when someone write to the bot
 
        sender = message['sender_full_name']
        content = message['content']
        print(f'{sender} wrote to the bot: "{content}"')
 
handler_class = BootlegBot
</syntaxhighlight>
 
===bootlegbot.zuliprc===


<pre>
<pre>
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
[api]
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
email=bootleg-bot@zulip.xpub.nl
    inet 127.0.0.1/8 scope host lo
key=XXXXXXXX
      valid_lft forever preferred_lft forever
site=https://zulip.xpub.nl
    inet6 ::1/128 scope host
      valid_lft forever preferred_lft forever
2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP group default qlen 1000
    link/ether dc:a6:32:54:34:1c brd ff:ff:ff:ff:ff:ff
    inet 145.24.153.55/23 brd 145.24.153.255 scope global dynamic noprefixroute eth0
      valid_lft 207029sec preferred_lft 174629sec
    inet6 fe80::9e59:5f86:ee6:e86d/64 scope link
      valid_lft forever preferred_lft forever
3: wlan0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
    link/ether dc:a6:32:54:34:1e brd ff:ff:ff:ff:ff:ff
    inet 10.9.8.1/24 brd 10.9.8.255 scope global noprefixroute wlan0
      valid_lft forever preferred_lft forever
    inet6 fe80::9724:36ee:d995:558e/64 scope link
      valid_lft forever preferred_lft forever
4: hub: <POINTOPOINT,MULTICAST,NOARP,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UNKNOWN group default qlen 500
    link/none
    inet 10.0.0.103/24 scope global hub
      valid_lft forever preferred_lft forever
    inet6 fe80::6fce:6106:9b56:33db/64 scope link stable-privacy
      valid_lft forever preferred_lft forever
</pre>
</pre>


Are we sharing a network with the bootleg library?
We need to share the key with each other somehow.


yes! the HUB
===Zulip bot API===


Can we check if we can communicate with the bootleg library through this network? (see all HUB ip address [[HUB|here]])
https://zulip.com/help/interactive-bots-api


ping 10.0.0.103
==hello Python!==


Who else is on the network right now?
see: [[Hello Python]]


nmap 10.0.0.*
==SSH to bootleg library==


And who else is on the eduroam right now? (in the same subnet)
There are two ways in which we can do this.


nmap 145.24.152.*
===laptop > sergio > bootleg library (from outside the school)===


We can make such a mapping because we are part of the same LAN network.
ssh sergio
sudo su - xpub
ssh pi@10.0.0.103


(LAN = local area network)
===laptop > bootleg library (on eduroam)===
ssh pi@145.24.153.55


But how do you travel from one network to another within the WAN?
==read database==


(WAN = wider area network, aka the internet)
* Simon and Luke made this Python script in 2021, to make the temporary index cards: https://git.vvvvvvaria.org/simoon/temporary-indexing
* documentation of sqlite module in Python: https://docs.python.org/3/library/sqlite3.html


traceroute zulip.xpub.nl
==write to database==


But how do we reach the hidden LAN/VPN 10.0.0.* network from the WAN?
* a standalone webform for file uploads
* using the bootleg library upload URLs
* hosted on sergio (but can be hosted on another sandbox too in the future)


ssh tunnelling!
==See also==


==SSH tunnels==
* [[The bootleg library]] main documentation page of the bootleg library project
* https://cc.practices.tools/etherdot/bootleg-library/ graph based story of the bootleg library project


https://ittavern.com/visual-guide-to-ssh-tunneling-and-port-forwarding/
[[Category:Workbooks]]

Latest revision as of 11:20, 24 March 2026

This page is prepared for the prototyping class on 3 March 2026 as part of SI29 and follows a Special Issue day with Doriane and Simon fully on topic of The bootleg library.

https://git.xpub.nl/kamo/bot-magic-words


the zulip bot

First install the requirements listed on this page:

https://zulip.com/help/writing-bots

You can run the bot with: 

zulip-run-bot --config-file bootlegbot.zuliprc bootlegbot.py

(or uv run zulip-run-bot --config-file bootlegbot.zuliprc bootlegbot.py if you are using uv)

bootlegbot.py

class BootlegBot(object):
    '''
    This is a small zulip bot to interact with the 👢🦵 library
    '''

    def usage(self):
        return '''Ask the bot about a book and they will search for it in the 👢🦵 library'''

    def handle_message(self, message, bot_handler):
        # This happens when someone write to the bot

        sender = message['sender_full_name']
        content = message['content']
        print(f'{sender} wrote to the bot: "{content}"')

handler_class = BootlegBot

bootlegbot.zuliprc

[api]
email=bootleg-bot@zulip.xpub.nl
key=XXXXXXXX
site=https://zulip.xpub.nl

We need to share the key with each other somehow.

Zulip bot API

https://zulip.com/help/interactive-bots-api

hello Python!

see: Hello Python

SSH to bootleg library

There are two ways in which we can do this.

laptop > sergio > bootleg library (from outside the school)

ssh sergio
sudo su - xpub
ssh pi@10.0.0.103

laptop > bootleg library (on eduroam)

ssh pi@145.24.153.55

read database

write to database

  • a standalone webform for file uploads
  • using the bootleg library upload URLs
  • hosted on sergio (but can be hosted on another sandbox too in the future)

See also

Retrieved from "https://pzwiki.wdka.nl/mw-mediadesign/index.php?title=Bootleg_bot&oldid=328624"