~netlandish/links

Requirements:

  • Go 1.21
  • GNU Make
  • PostgreSQL (any modern version should work)
#Build
  1. Clone the repository links and change into the repository directory.
  • ~/links $ make all links-admin links-domains
  1. Copy the example configuration file
  • cp config.example.ini config.ini
  1. Edit config.ini with your settings. The config file has info for settings that aren't self explanatory
  2. Run database migrations:
  • ./links migrate
  1. Setup your first admin user
  • ./links-admin setup
  • Note, this step will ask for the domains that will be used for the links, links-short and links-list services.
  • Another note: If you are running this on your local computer for development or just playing around, please see the development document for extra steps needed here.

#Running

For all services you will need the links-api service running. The API server is what powers everything so it's a requirement for basically every single route handler (web page, etc.).

  1. In one terminal run the api service
  • ./links-api
  1. In another terminal run the links service.
  • ./links
  1. Load the service in your browser. By default the URL is http://127,0.0.1:8000
  2. To use the shorts (link shortening) or list (link listing) services then you must also run those services in a separate terminal.

#Deployment

To run this on your own servers, see the Self Host documentation for tips and suggestions for how to deploy it.

About this wiki

commit 2aac1348afc29af64b6d24324bd435bffb2881d1
Author: Peter Sanchez <peter@netlandish.com>
Date:   2025-02-24T14:03:34-06:00

Fixing anchor name in support doc
Clone this wiki
https://git.code.netlandish.com/~netlandish/links-wiki (read-only)
git@git.code.netlandish.com:~netlandish/links-wiki (read/write)