Shlink - Revision history

O32patel: change shlink group

2024-11-16T04:13:36Z

change shlink group

← Older revision		Revision as of 23:13, 15 November 2024
Line 7:		Line 7:

	== Usage ==		== Usage ==
	Links can be managed at [https://links.csclub.uwaterloo.ca links.csclub.uwaterloo.ca], or through the CLI (currently restricted to the <code>~~staff~~</code> group).		Links can be managed at [https://links.csclub.uwaterloo.ca links.csclub.uwaterloo.ca], or through the CLI (currently restricted to the <code>exec</code> group).
	[[File:Shlink1.png\|none\|thumb\|When you open it for the first time, you will see an interface that looks like this. Click '''Add a server'''.]]		[[File:Shlink1.png\|none\|thumb\|When you open it for the first time, you will see an interface that looks like this. Click '''Add a server'''.]]
	[[File:Shlink2.png\|none\|thumb\|Enter the details as follows. Name: <code>csclub.ca</code> URL: <code><nowiki>https://csclub.ca</nowiki></code> API key: The exec API key (in the usual exec passwords location, or ask an exec for it if you aren't one)]]		[[File:Shlink2.png\|none\|thumb\|Enter the details as follows. Name: <code>csclub.ca</code> URL: <code><nowiki>https://csclub.ca</nowiki></code> API key: The exec API key (in the usual exec passwords location, or ask an exec for it if you aren't one)]]

R389li: Add setup instructions

2022-09-10T18:58:04Z

Add setup instructions

← Older revision		Revision as of 13:58, 10 September 2022
Line 8:		Line 8:
	== Usage ==		== Usage ==
	Links can be managed at [https://links.csclub.uwaterloo.ca links.csclub.uwaterloo.ca], or through the CLI (currently restricted to the <code>staff</code> group).		Links can be managed at [https://links.csclub.uwaterloo.ca links.csclub.uwaterloo.ca], or through the CLI (currently restricted to the <code>staff</code> group).
			[[File:Shlink1.png\|none\|thumb\|When you open it for the first time, you will see an interface that looks like this. Click '''Add a server'''.]]
			[[File:Shlink2.png\|none\|thumb\|Enter the details as follows. Name: <code>csclub.ca</code> URL: <code><nowiki>https://csclub.ca</nowiki></code> API key: The exec API key (in the usual exec passwords location, or ask an exec for it if you aren't one)]]
			On the next interface, '''custom slug''' is the part of the URL that can be customized. If it is left blank, a random 4-character slug will be generated.

	Use the <code>csctest</code> parameter to disable tracking on test requests.		Use the <code>csctest</code> parameter to disable tracking on test requests.

R389li: Create page

2022-08-29T06:11:25Z

Create page

New page

[https://shlink.io/ Shlink] is a self-hosted URL shortener. We run an instance on [[Machine List#caffeine|caffeine]], currently for exec-use only.

== Installation Details ==
Shlink was installed manually (as of F2022 there is currently no Debian package for it). Its files are in <code>/usr/local/lib/shlink</code> on caffeine, with a symlink of <code>bin/cli</code> (the Shlink CLI) to <code>/usr/local/bin/shlink</code> as recommended by Shlink's docs. Due to Shlink only supporting PHP 8.2, which is in debian-unstable at the moment, the installation and CLI scripts were modified to use the <code>php8.2</code> binary installed from <code>packages.sury.org</code>.

The web client (used to manage shortlinks graphically, the other option being the CLI) sources are located in <code>/usr/local/bin/shlink/web-client/</code>. Apache is configured (through <code>sites-available/csc-links.conf</code> and <code>sites-real/csc-links</code>) to serve actual shortlinks through [https://csclub.ca csclub.ca] (which itself redirects to the CSC homepage) and the web client through [https://links.csclub.uwaterloo.ca links.csclub.uwaterloo.ca].

== Usage ==
Links can be managed at [https://links.csclub.uwaterloo.ca links.csclub.uwaterloo.ca], or through the CLI (currently restricted to the <code>staff</code> group).

Use the <code>csctest</code> parameter to disable tracking on test requests.