Skip to content

Commit

Permalink
Add script example of downloading, configuring and running Yetibot
Browse files Browse the repository at this point in the history
  • Loading branch information
devth committed May 28, 2017
1 parent 5306cde commit 02e02e2
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -21,3 +21,4 @@ pom.xml.asc
profiles.clj
.idea/
*.iml
.nrepl-port
2 changes: 1 addition & 1 deletion doc/DOCKER.md
Expand Up @@ -21,7 +21,7 @@ Yetibot runs a webapp on port `3000`. You may optionally expose it via `-P` or
The most minimal incantation to run a Yetibot is:

```
docker run -e YB_ADAPTERS_IRC_TYPE="irc" devth/yetibot
docker run -it --rm -e YB_ADAPTERS_IRC_TYPE="irc" devth/yetibot
```

This will join Freenode with a username like `yetibot_$rand` where `$rand` is a
Expand Down
49 changes: 47 additions & 2 deletions doc/GETTING_STARTED.md
Expand Up @@ -30,12 +30,57 @@ docs.
There are a few ways to quickly run a Yetibot:

1. Docker - [read the Yetibot on Docker docs](doc/DOCKER.md)
2. Grab an archive of the source from the [Yetibot
1. Grab an archive of the source from the [Yetibot
releases](https://github.com/devth/yetibot/releases), unzip, put the config
in place and `lein run`
3. Clone the source of this repo, put the config in place and `lein run`
1. Clone the source of this repo, put the config in place and `lein run`

As an example, here's how you could get the latest code from `master`, extract,
put config in place, and run it (assumes you already have
[Leiningen](https://github.com/technomancy/leiningen) installed):

```bash
cd /tmp
curl https://codeload.github.com/devth/yetibot/tar.gz/master | tar xvz
cd yetibot-master
cat << EOF > config.edn
{:yetibot
{:adapters
{:freenode
{:type "irc"
:username "my-yetibot"
:host "chat.freenode.net"
:port "7070"
:ssl "true"}}}}
EOF
YB_LOG_LEVEL=debug CONFIG_PATH=config.edn lein run
```

Once it starts up you'll see a log like:

```
17-05-28 23:27:56 deep.local INFO [yetibot.core.loader:41] - ☑ Loaded 84 namespaces matching [#"^yetibot\.(core\.)?commands.*" #"^.*plugins\.commands.*"]
```

At this point it should be connected to Freenode. Trying running a command
against it:

```bash
/msg my-yetibot !echo Hello, Yetibot!
```

And you should get a reply:

```bash
my-yetibot: Hello, Yetibot!
```

**NB**: Soon there will be a way to run a Yetibot with zero config in local REPL
mode :zap: #628 :zap:

## Questions

If these docs don't work for you please [open an
issue](https://github.com/devth/yetibot/issues/new)!

You can also try setting an env var `YB_LOG_LEVEL=debug` when running.

0 comments on commit 02e02e2

Please sign in to comment.