Help

Browser Setup

You can configure your browser to treat the address bar as a go links launcher by adding a custom search engine.

Chrome

  • Navigate to chrome://settings/searchEngines
  • Click "Add" next to Site Search
  • Set the keyword to go (or any short keyword you prefer)
  • Set the URL to https://go.d1m.dev/%s

After setup, type go in the address bar, press Tab, then type your alias to navigate directly.

Firefox

  • Bookmark any page from your deployment
  • Edit the bookmark and set a keyword (e.g., go)
  • Change the URL to https://go.d1m.dev/%s

Type your keyword in the address bar followed by the alias to navigate directly.

Running Locally

Prerequisites:

  • Node.js
  • Docker (for the database)
  • yarn
# Start PostgreSQL
docker-compose up -d db

# Run database migrations
export DATABASE_URL=postgres://dev:dev@127.0.0.1:5432/golinks?sslmode=disable
dbmate up

# Install dependencies
yarn

# Start development server
yarn dev

Create a .env.local file based on .env.example. To disable authentication, set AUTH0_ENABLED=false.

Deploying

Docker

docker build . -t golinks
docker run -p 3000:3000 --env-file .env golinks

A pre-built image is available at armand1m/golinks.

Fly.io

fly deploy
fly secrets set DATABASE_CONNECTION_STRING=...
fly secrets set AUTH0_DOMAIN=...

See fly.toml for the deployment configuration.

Kubernetes

Kubernetes manifests are available in the ./kubernetes directory of the repository, including Cloud SQL proxy setup and secrets configuration.

Repository

The source code is available at github.com/armand1m/golinks. The project is licensed under MIT. Contributions, bug reports, and feature requests are welcome via issues and pull requests.