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

Github Pages compatibility #366

Open
stevenleeg opened this issue Mar 26, 2014 · 24 comments
Open

Github Pages compatibility #366

stevenleeg opened this issue Mar 26, 2014 · 24 comments

Comments

@stevenleeg
Copy link

@stevenleeg stevenleeg commented Mar 26, 2014

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
Copy link

@MattSurabian MattSurabian commented Mar 26, 2014

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
Copy link

@MattSurabian MattSurabian commented Mar 26, 2014

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

include: [".well-known"]
@stevenleeg
Copy link
Author

@stevenleeg stevenleeg commented Mar 27, 2014

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
Copy link

@wsargent wsargent commented Mar 27, 2014

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

@MattSurabian
Copy link

@MattSurabian MattSurabian commented Mar 27, 2014

@wsargent I put it in the root of my jekyll repo:

https://github.com/MattSurabian/mattsurabian.github.io

@wsargent
Copy link

@wsargent wsargent commented Mar 27, 2014

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
Copy link
Contributor

@malgorithms malgorithms commented Mar 27, 2014

@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
Copy link

@wsargent wsargent commented Mar 27, 2014

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
Copy link
Contributor

@malgorithms malgorithms commented Mar 27, 2014

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

@MattSurabian
Copy link

@MattSurabian MattSurabian commented Mar 27, 2014

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

@wsargent
Copy link

@wsargent wsargent commented Mar 27, 2014

@MattSurabian added you.

@MattSurabian
Copy link

@MattSurabian MattSurabian commented Mar 27, 2014

@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
Copy link

@wsargent wsargent commented Mar 27, 2014

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

@stevenleeg
Copy link
Author

@stevenleeg stevenleeg commented Mar 27, 2014

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
Copy link

@MattSurabian MattSurabian commented Mar 27, 2014

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
Copy link

@MattSurabian MattSurabian commented Mar 27, 2014

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

@DominikTo
Copy link

@DominikTo DominikTo commented Mar 30, 2014

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
Copy link

@hallettj hallettj commented Mar 31, 2014

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
Copy link

@tphummel tphummel commented Mar 31, 2014

adding include: [".well-known"] worked for me, as well as permalink: .well-known/keybase.txt. 👍

@huseyint
Copy link

@huseyint huseyint commented Apr 3, 2014

@MattSurabian thanks bunch, worked like a charm!

jeffmccune added a commit to jeffmccune/jeffmccune.com that referenced this issue Apr 8, 2014
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.
bd808 added a commit to bd808/bd808.github.com that referenced this issue Sep 30, 2014
Note the changes to _config.yml which tell Octopress and GitHub to
publish the .well-known directory. See also
keybase/keybase-issues#366
s4y added a commit to s4y/blog that referenced this issue Jan 19, 2016
ebekker added a commit to ebekker/bkkr.us that referenced this issue Mar 7, 2017
Needed to add one of the supported keybase.io proof files as per [this comment](keybase/keybase-issues#366 (comment)).
@wakest
Copy link

@wakest wakest commented Jun 2, 2018

thank you @hallettj this just solved a problem I was working on for hours!

mpchadwick added a commit to mpchadwick/mpchadwick.github.io that referenced this issue Dec 15, 2018
dlecan added a commit to BlockchainEtSociete/blockchainsociete.org that referenced this issue Apr 23, 2019
@amanijoseph87
Copy link

@amanijoseph87 amanijoseph87 commented Apr 27, 2019

Is there a way to add this on html

dlecan added a commit to BlockchainEtSociete/blockchainsociete.org that referenced this issue May 15, 2019
jontsai added a commit to jontsai/jontsai.github.com that referenced this issue Jun 1, 2019
imann24 added a commit to imann24/online-portfolio that referenced this issue Jul 2, 2019
imann24 added a commit to imann24/online-portfolio that referenced this issue Jul 2, 2019
Nircek added a commit to Nircek/nircek.github.io that referenced this issue Aug 4, 2019
@Nircek
Copy link

@Nircek Nircek commented Aug 4, 2019

Thanks. I think the issue should be closed due to being solved.

@OR13
Copy link

@OR13 OR13 commented Aug 8, 2019

Adding a .nojekyll file to the directory that is served by github solved this for me.

artob added a commit to artob/ar.to that referenced this issue Aug 24, 2019
circuit-split added a commit to blackacre-openpgp/blackacre-openpgp.github.io that referenced this issue Sep 24, 2019
MarkelFe added a commit to MarkelFe/website that referenced this issue Apr 5, 2020
Trying to make available the .well-known directory in Github Pages. The idea comes from [this issue](keybase/keybase-issues#366)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
You can’t perform that action at this time.