Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 3.55 KB

README.md

File metadata and controls

65 lines (38 loc) · 3.55 KB
Raw

I'm OK (imok)

Imok is a simple bot to support people undertaking potentially risky activities. It's aimed at community groups who support these vulnerable people.

The bot lets users 'check in' to the service with an SMS or messaging app. If users don't 'check out' after 30 minutes (for example), it will raise an alarm in a Telegram groupchat.

Example use cases are:

  • Supporting protestors at risk of arrest or kidnapping
  • Supporting women and LGBTQ+ people walking home at night, or going on dates
  • Supporting journalists or medical staff in warzones
  • Supporting asylum seekers through 'signing in' processes (see #AbolishReporting on Twitter).

Imok is currently optimised for the latter use case. It is a collaboration between No Borders Manchester and Geeks for Social Change that emerged from the Resistance Lab collective.

We do not currently offer a public instance of imok, and so you will need to set up your own server to use it. The target audience is therefore local mutual aid and community support groups with the capacity and confidence to run a web service.

We currently support SMS and Telegram. WhatsApp is theoretically supported but requires a WhatsApp Business API account, which we do not have.

Please note that imok is currently beta quality software and has not yet been tested in a "real life" setting.

How it works

For support workers (admins)

Imok currently requires an admin to invite new users to the system. We expect these invites to happen in community venues and at protests for example. This is both for server security and to keep costs down.

  1. You add people you want to support ('members') in the imok admin interface
  2. imok will send an SMS inviting the person to register
  3. Once the person responds to the SMS to confirm they wish to register, the admin groupchat is notified
  4. If a timer expires or a member sends an SOS message, it sends a notification to the admin groupchat

We will be further developing admin documentation as the project develops.

For members

As a member of an imok instance:

  1. You will receive an SMS asking if you want to join the server. After replying to this, the system registers you.
  2. You can then text the number IN before conducting the risky activity
  3. If you text OUT within the designated time, nothing happens
  4. If you don't, admins get notified that something is wrong
  5. If you text SOS, admins are immediately notified

That's it! All server commands are listed on the imok wiki.

Installation and deployment

To find out how to install imok, set up a development environment or provide translations check out the imok wiki on GitHub.

Support

We have a Discord server for support and feedback.

We can also set up an installation for you for a fee. All funds raised go towards improving imok. Email kim@gfsc.studio or join the Discord server if you'd like to chat about this.

Donations

Imok has been developed entirely by volunteers in the Geeks for Social Change collective. If you'd like to support development, please consider sending us a one-off or regular donation.

ko-fi

License

Imok is released under the MIT license.