Skip to content
This repository has been archived by the owner on Jun 10, 2021. It is now read-only.

Commit

Permalink
doc: fix issues and remove heroku section
Browse files Browse the repository at this point in the history
  • Loading branch information
freemountain committed Jun 23, 2018
1 parent 6bf6db8 commit d2ee10e
Showing 1 changed file with 15 additions and 28 deletions.
43 changes: 15 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Bridge between Twitter and Mastodon (or any OStatus-compliant instance). Powered by [go-ostatus](https://github.com/emersion/go-ostatus).

For the moment, this is a read-only bridge: you'll be able to see Twitter
activity from Mastodon (try to follow to follow _twitter_username@rootURL_), but you won't be able to interact with it.
activity from Mastodon (try to follow _twitter_username@rootURL_), but you won't be able to interact with it.

## Usage

Expand All @@ -17,43 +17,30 @@ emuarius
```

### Docker

```shell
docker build -t emuarius .
docker run -e "EMUARIUS_TWITTER_CONSUMER_KEY=xxx" \
docker run -p 4004:4004 \
-e "EMUARIUS_TWITTER_CONSUMER_SECRET=xxx" \
-e "EMUARIUS_TWITTER_ACCESS_TOKEN=xxx" \
-e "EMUARIUS_TWITTER_ACCESS_TOKEN_SECRET=xxx" emuarius
```

### Heroku
You need the heroku [cli tool](https://devcenter.heroku.com/articles/heroku-cli).
```shell
heroku container:login
heroku create
heroku container:push web
heroku container:release web
heroku ps:scale web=1
heroku open # The opened url is the EMUARIUS_ROOT_URL
-e "EMUARIUS_TWITTER_ACCESS_TOKEN_SECRET=xxx" \
-e "EMUARIUS_TWITTER_CONSUMER_KEY=xxx" emuarius
```
Configure environment variables with Twitter app credentials inside the [dashboard](https://dashboard.heroku.com/). You dont need to set _EMUARIUS_ADDRESS_ or _EMUARIUS_ROOT_URL_



## Configuration

You can configure emuarius with a toml configuration file or environment variables. Environment variables will take precedence over toml values.


| toml | env | default |
| ------------------------- | ----------------------------------- | --------------------- |
| address | EMUARIUS_ADDRESS | :4004 |
| rootURL | EMUARIUS_ROOT_URL | http://localhost:4004 |
| databasePath | EMUARIUS_DATABASE_PATH | ./emuarius.db |
| twitter.consumerKey | EMUARIUS_TWITTER_CONSUMER_KEY | |
| twitter.consumerSecret | EMUARIUS_TWITTER_CONSUMER_SECRET | |
| twitter.accessToken | EMUARIUS_TWITTER_ACCESS_TOKEN | |
| twitter.accessTokenSecret | EMUARIUS_TWITTER_ACCESS_TOKEN_SECRET | |

| toml | env | default |
| ------------------------- | ------------------------------------ | ---------------------- |
| | PORT | |
| address | EMUARIUS_ADDRESS | :4004 or 0.0.0.0:$PORT |
| rootURL | EMUARIUS_ROOT_URL | http://localhost:4004 |
| databasePath | EMUARIUS_DATABASE_PATH | ./emuarius.db |
| twitter.consumerKey | EMUARIUS_TWITTER_CONSUMER_KEY | |
| twitter.consumerSecret | EMUARIUS_TWITTER_CONSUMER_SECRET | |
| twitter.accessToken | EMUARIUS_TWITTER_ACCESS_TOKEN | |
| twitter.accessTokenSecret | EMUARIUS_TWITTER_ACCESS_TOKEN_SECRET | |

## License

Expand Down

0 comments on commit d2ee10e

Please sign in to comment.