Github Pages compatibility #366

Open
stevenleeg opened this Issue Mar 26, 2014 · 20 comments

Projects

None yet

8 participants

@stevenleeg

Hey guys!

I'm noticing a bit of an issue when trying to verify your website with Github pages. I use GH pages to run my domain's website, however it appears that pages doesn't serve folders starting with a period (eg, .well-known), so I'm unable to verify my domain.

Anyone know of a workaround?

@MattSurabian

You're right! It's cause of the . in the directory name, no worries:
https://help.github.com/articles/files-that-start-with-an-underscore-are-missing

@MattSurabian

I'll add I opted for using the include directive in the _config.yml and it worked like a charm.

include: [".well-known"]
@stevenleeg

This worked perfectly. Thanks!

On Wednesday, March 26, 2014 at 6:36 PM, Matthew Surabian wrote:

I'll add I opted for using the include directive in the _config.yml and it worked like a charm.
include: [".well-known"]

โ€”
Reply to this email directly or view it on GitHub (#366 (comment)).

@wsargent

where do you put the file on the filesystem? I'm still having no luck in generating it.

@wsargent

That's where I have it, in both my gh-pages branch and my master branch. I see it in Github, but don't see a path to it: http://tersesystems.com/.well-known/keybase.txt is 404.

@malgorithms
Contributor

@wsargent did you try @MattSurabian 's solution with the config file?

We are strongly considering changing the default path of keybase proofs out of the ./well-known and just into the top folder now, due to this difficulty. Both because (a) it's apparently annoying in certain hosting platforms to host a dot folder, and (b) because some users aren't noticing the dot.

@wsargent

I have tried include: [".well-known"] in the _config.yml file and I have
checked it and run "rake generate; rake deploy" and all that. Still no
dice. :-(

@malgorithms
Contributor

Ok, maybe someone else has an idea. Very frustrating!

@MattSurabian

@wsargent is it possible to link to the github pages repo?

@wsargent

@MattSurabian added you.

@MattSurabian

@wsargent I believe the source of your trouble is this line:

source: source

I see you've already added a .well-known/keybase.txt in the source directory so it should be as simple as updating this line to this:

include: ["source/.well-known"]

I'd try it myself but didn't want to be too forward! Good luck!

@wsargent

@MattSurabian I've added the line, but it doesn't seem to be working, even when I try "rake preview". This is bizarre.

@stevenleeg

Have you tried just running 'jekyll serve --watch'?

On Thu, Mar 27, 2014 at 3:22 PM, Will Sargent notifications@github.com
wrote:

@MattSurabian I've added the line, but it doesn't seem to be working, even when I try "rake preview". This is bizarre.

Reply to this email directly or view it on GitHub:
#366 (comment)

@MattSurabian

This seems like it might be an issue with Octopress, there are a old issues on the octopress github from people having trouble with dotfiles and octopress. Have you looked into the copydot rake task?

@MattSurabian

Ah, looks like the rake file excludes dot named directories:
https://github.com/wsargent/tersesystems/blob/master/Rakefile#L230-L235

@DominikTo

With Jekyll on GitHub Pages just add a file keybase.txt in your root and add the following header:

---
layout: none
permalink: .well-known/keybase.txt
---
@hallettj

For those using Octopress who are having this issue, here is a fix.

Create an empty file in your source directory called ".nojekyll":

$ touch source/.nojekyll

Edit _config.yml and add this line:

include: [".well-known", ".nojekyll"]

Deploy as usual!

The Octopress rake tasks build your site locally and just upload the resulting static files into your master branch. Then Github builds your site a second time. (The second build usually has no effect since Jekyll does nothing to regular static files.) Since Octopress does not include _config.yml in your master branch, Github does not see your include setting and therefore excludes .well-known. But by including the .nojekyll file you instruct Github not to build the site itself, and to just serve the files as-is.

@tphummel

adding include: [".well-known"] worked for me, as well as permalink: .well-known/keybase.txt. ๐Ÿ‘

@huseyint
huseyint commented Apr 3, 2014

@MattSurabian thanks bunch, worked like a charm!

@jeffmccune jeffmccune added a commit to jeffmccune/jeffmccune.com that referenced this issue Apr 8, 2014
@jeffmccune jeffmccune Publish the .well-known directory
Without this patch the .well-known directory is not published because
github-pages ignores directories starting with a dot.  This issue is
mentioned specifically at
keybase/keybase-issues#366

This patch configures github-pages to publish the .well-known folder.
2e4f531
@bd808 bd808 added a commit to bd808/bd808.github.com that referenced this issue Sep 30, 2014
@bd808 bd808 keybase verification
Note the changes to _config.yml which tell Octopress and GitHub to
publish the .well-known directory. See also
keybase/keybase-issues#366
fe91ade
@s4y s4y added a commit to s4y/blog that referenced this issue Jan 19, 2016
@s4y s4y Tell Jekyll to include .well-known ab1e354
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment