Skip to content

Latest commit

 

History

History
122 lines (68 loc) · 4.13 KB

Hosting your own Hackfoldr 2.0.md

File metadata and controls

122 lines (68 loc) · 4.13 KB
Raw

Tutorial: Hosting your own Hackfoldr 2.0

In other languages:

What is Hackfoldr 2.0

Hackfoldr is a convenience web folder to store links for your collaborative open source projects.

A sample folder - http://beta.hackfoldr.org/hackfolder_template

How does it work

Each hackfoldr uses an ethercalc.org spreadsheet as its live configuration file. Each row of the spreadsheet represents a link. You can also set each link with supplementary properties. For example, to open in a new window, act as a subfolder, or tag with colored labels.

Hosting your own Hackfoldr

It's as easy as fork & customize

Benefit

  • Use your own domain name and customize the landing page.

    For example, http://beta.hackfoldr.org/ linked to ethercalc.org/welcome-to-hackfoldr

    And http://folder.moztw.org/ linked to ethercalc.org/moztw, which stored all docs related to MozTW, Mozilla Taiwan Community.

  • You will be able to enable the hidden shortcut menu on your own instance.

Steps

Step 0: Getting Started

You will need the following to proceed:

  • A domain name
  • A github account

Step 1: Fork Hackfoldr 2.0 repo

  1. Go to https://github.com/hackfoldr/hackfoldr-2.0-forkme

  2. Click the top right “fork” button

Step 2: Edit CNAME file in gh-pages branch

  1. Go to your shiny new repo

  2. Switch to gh-pages branch at top left branch dropdown button

  3. Click and open CNAME file in root directory

  4. Click top right “pencil” button to edit the CNAME file

  5. Put your domain in the CNAME file

    Make sure that CNAME file contains only One Single Line, example

Step 3: Set up your DNS

Add a CNAME record of your domain, and set the destination to _YOUR_GITHUB_ACCOUNT_.github.io

  • Example for Amazon Router 53

      name: _YOUR_DOMAIN_NAME_.
  type: CNAME
  value: _YOUR_GITHUB_REPO_NAME_.github.io 
  evaluate target: -
  health check id: -
  ttl: 300

    Example,

      name: folder.moztw.org.
  type: CNAME
  value: moztw.github.io
  evaluate target: -
  health check id: -
  ttl: 300

  • Example for Cloudflare

Step 4: Customize your Hackfoldr

  1. Clone this template sheet into new ethercalc, and named whatever SLUG you want

  2. Switch to gh-pages branch of your forked repo

    Thanks Github for their wonderful Project Page feature, save us from renting own server for host hackfolder.

  3. Edit index.html file and adjust the following settings

  • Change the linked ethercalc SLUG on line 3

  • Adjsut the drop-down menu as you wish in <div class="menu">

  • If you would like to use hackpad page generate feature, adjust default hackpad site on line 644

  • Clone everything from index.html to 404.html

  • Enable "Enforce HTTPS" under your Github repo's setting pafge to ensure user's privacy.

You've done all the works!

Be patient and waiting for domain name record to be active. It shouldn't cost you too much time, typically no longer then 10 mins.

Development

Please refer to this docs (in Chinese for now) or README for contributing Hackfoldr-beta project.