Skip to content

Commit

Permalink
Add Ubuntu & WSL notes to README.md (#3542)
Browse files Browse the repository at this point in the history
  • Loading branch information
Carlgo11 authored and mxxcon committed Dec 5, 2018
1 parent c619c43 commit 5c749af
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,23 @@ In order to run the site locally, it is necessary to install bundler, install al
the site. If the `gem` command is not available to you, it is necessary to install Ruby with RubyGems.
Once Ruby and RubyGems are installed and available from the command line, TwoFactorAuth can be setup using the following commands.

```
```shell
gem install bundler
cd ~/twofactorauth
bundle install
bundle exec jekyll serve
```

If you're using Ubuntu or [Bash on Windows (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install-win10) you'll probably need to install these dependencies first:

```shell
sudo apt install libffi-dev nodejs python-dev gcc ruby rails make zlib1g-dev ruby-dev libcurl3
gem install bundler
```

The TwoFactorAuth website should then be accessible from `http:https://localhost:4000`.

Another option is to run Jekyll inside a Docker container. Please read the [Jekyll Docker Documentation](https://github.com/envygeeks/jekyll-docker/blob/master/README.md) on how to do this.
Another option is to run Jekyll inside a [Docker](https://www.docker.com/) container. Please read the [Jekyll Docker Documentation](https://github.com/envygeeks/jekyll-docker/blob/master/README.md) on how to do this.

## License

Expand Down

0 comments on commit 5c749af

Please sign in to comment.