Skip to content

Latest commit

 

History

History
102 lines (75 loc) · 3.63 KB

README.md

File metadata and controls

102 lines (75 loc) · 3.63 KB
Raw

Suri

Your own short links as an easily deployed static site with Docker

You're viewing a template repository tailored for deploying Suri with Docker. That could be on a cloud platform that supports Docker container images, or just on your own machine. Head over to the main repository to learn more about Suri, including additional deployment options.

Setup: Step By Step

  1. Hit the "Use this template" button above and then "Create a new repository". Fill in the required details to create a new repository based on this one.

  2. Make sure you have Docker installed and running. Docker Desktop is an easy way to get started on your own machine.

  3. Build a Docker image named suri from the Dockerfile:

    docker build --tag suri .

    This uses docker-static-website to produce a very small image.

  4. Start a new container using the image, which serves the static site on port 3000:

    docker run --interactive --tty --rm --init --publish 3000:3000 suri

Build Only, Don't Serve

If you're just looking to build the static site, but not serve it, you can change the docker build command to export the build directory from the Docker image to your host machine:

docker build --target=export --output=build --tag suri .

Keep in mind that this won't remove any existing files in the build directory on your host machine, so you may want to delete the directory beforehand.

How It Works

Manage Links

At the heart of Suri is the links.json file, located in the src directory, where you manage your links. All of the template repositories include this file seeded with a few examples:

{
  "/": "https://www.youtube.com/watch?v=CsHiG-43Fzg",
  "1": "https://fee.org/articles/the-use-of-knowledge-in-society/",
  "gh": "https://github.com/surishortlink/suri"
}

It couldn't be simpler: the key is the "short link" path that gets redirected, and the value is the target URL. Keys can be as short or as long as you want, using whatever mixture of characters you want. / is a special entry for redirecting the root path.

Build Static Site

Suri ships with a suri executable file that generates the static site from the links.json file. The static site is output to a directory named build.

All of the template repositories are configured with a build script that invokes this executable, making the command you run simple:

npm run build

When you make a change to the links.json file, simply re-run this command to re-generate the static site, which can then be re-deployed.

Config

Configuration is handled through the suri.config.json file in the root directory. There is only one option at this point:

Option Description Type Default
js Whether to redirect with JavaScript instead of a <meta> refresh. Boolean false

Public Directory

Finally, any files in the public directory will be copied over to the build directory without modification when the static site is built. This can be useful for files like favicon.ico or robots.txt (that said, Suri provides sensible defaults for both).