Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify Getting Started section of readme #45

Open
ghost opened this issue Jun 25, 2020 · 0 comments
Open

Clarify Getting Started section of readme #45

ghost opened this issue Jun 25, 2020 · 0 comments

Comments

@ghost
Copy link

ghost commented Jun 25, 2020

The last line of the Getting Started section of the readme states:

With default settings, you should be able to view the site locally at http://127.0.0.1:4000/

I chose to install Chowdown within LXC on an Ubuntu server with no desktop. I had no issues with the Jekyll and Chowdown installations, but couldn't access the actual site from my LAN. I spent a few hours validating firewall settings, IP addessing on the container, reading the individual Chowdown files, and digging through Jekyll documentation before I happened upon an obscure post on Stackoverflow.

I think it would be good to add that Jekyll can be launched with the --host=0.0.0.0 option (or a specific IP can be specified if you don't want to bind to all ports). Or possibly replace the 'serve locally' configuration altogether. I'd imagine more people are interested in accessing their Chowdown site from their LAN or the internet than specifically on whatever machine they installed it on.

So for the actual proposals.

Option 1:
Add a new sentence right after

With default settings, you should be able to view the site locally at http://127.0.0.1:4000/

"To access Chowdown remotely, use the command jekyll serve --host=0.0.0.0 to bind Jekyll to all interfaces on the server. Ensure firewall rules are in place to allow remote access. You should then be able to view the site by browsing to http://[Server IP]:4000."

Option 2:
Starting with the line

Clone or download this repo. Navigate to the folder in terminal (or iTerm, etc), and then run:

  • Replace jekyll serve with jekyll serve --host 0.0.0.0
  • Replace "With default settings, you should be able to view the site locally at http://127.0.0.1:4000/" with "You should be able to access Chowdown remotely using the server IP by browsing to http://[Server IP]:4000/"
@ghost ghost mentioned this issue Jun 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

0 participants