Skip to content

Commit

Permalink
[README] More prominent troubleshooting section
Browse files Browse the repository at this point in the history
brendan-r committed Jan 31, 2016
1 parent b4b8313 commit 8ccdaa5
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -135,10 +135,20 @@ BOX_CLIENT_SECRET="yoursecrethere"
#### Contributing
Always very welcome! If you'd like to submit a pull request for a new feature, ideally it would be documented, come with an addtion to [NEWS.md](NEWS.md), and have a test or two. This project has a standard [Code of Conduct](CONDUCT.md).

#### Troubleshooting
##### Remote Usage (e.g. ssh / rstudio-server)
This proves tricky for the OAuth2.0 dance, as it relies on browser access. While not 'officially supported', it's possible to authenticate on a local machine to generate a cached token (by default, at `~/.boxr-oauth`), and then copy the file over to the eqivalent location on the remote machine. boxr can then read the copied file during remote code execution.

## Troubleshooting
Via [GitHub issues](https://github.com/brendan-R/boxr/issues), please. It's been a while since I've read the R mailing lists!

##### Problems Authenticating
### In General
If you run in to problems, first make sure that your credentials are correct, and that you're using the latest version of boxr. You can update boxr with:

```
install.packages("boxr")
```

### Problems Authenticating
Sometimes an old token can cause problems during authentication. If you're sure that your `client_id` and `client_secret` are correct, but `box_auth()` isn't working, try the following in a fresh session:

```r
@@ -149,10 +159,6 @@ box_fresh_auth() # Delete the old token, and reauthenticate

This will delete the old token (by default stored at `~/.boxr-oauth`), and start the auth process afresh. A browser window will open, and you'll be prompted to sign in to your box account to verify yourself.

##### Remote Usage (e.g. ssh / rstudio-server)
This proves tricky for the OAuth2.0 dance, as it relies on browser access. While not 'officially supported', it's possible to authenticate on a local machine to generate a cached token (by default, at `~/.boxr-oauth`), and then copy the file over to the eqivalent location on the remote machine. boxr can then read the copied file during remote code execution.


## License
The MIT License (MIT)

0 comments on commit 8ccdaa5

Please sign in to comment.