Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ergl/clojurebot

ClojureBot - A remote REPL inside Telegram
https://github.com/ergl/clojurebot

Last synced: about 1 month ago
JSON representation

ClojureBot - A remote REPL inside Telegram

Host: GitHub
URL: https://github.com/ergl/clojurebot
Owner: ergl
License: other
Created: 2015-07-04T21:30:18.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2015-09-27T21:01:36.000Z (about 9 years ago)
Last Synced: 2023-02-28T12:17:11.529Z (over 1 year ago)
Language: Clojure
Size: 141 KB
Stars: 13
Watchers: 2
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# ClojureBot

ClojureBot is a Telegram bot that lets you evaluate your own Clojure expressions, anywhere, anytime.

## Usage

You'll need to get your own [Telegram API key](https://core.telegram.org/bots#3-how-do-i-create-a-bot).

ClojureBot uses [Environ](https://github.com/weavejester/environ), so you should set your `api-key` environment variable to your own key.

If you are running the bot using [leiningen](http://leiningen.org), you can add your key to your `profiles.clj` file, like so:

```clojure
{:dev
{:env {:api-key "your-api-key"}}}
```

ClojureBot also uses [clojail](https://github.com/Raynes/clojail). From the README:

>Because clojail employs the JVM's built in sandboxing, you'll need to have a ~/.java.policy file to define permissions for your own code. If you don't do this, you'll get security exceptions. I've included a very liberal example.policy file that you can just copy over to ~/.java.policy.

Then, just `lein run` inside your project folder.

## Limitations

All the clojure code you pass to the bot is evaluated in a sandbox.

This specific implementation disallows the creation of `defs` and all filesystem and network access. Long-running processes will be terminated (issuing a Timeout Exception).

You can override this by changing the tester used in `sandbox.clj`.

Just change the `clj-telegrambot-tester` variable to include your preferred clojail tester.

## License

The use and distributon for this software are covered by the [Eclipse Public License 1.0](https://www.eclipse.org/legal/epl-v10.html).