From 67b00433e9a2be48db7b80fe42daea9ce2591346 Mon Sep 17 00:00:00 2001 From: Peter Sanchez Date: Mon, 9 Dec 2024 18:48:04 -0600 Subject: [PATCH] Adding custom domains doc --- custom-domains.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++ index.md | 1 + 2 files changed, 82 insertions(+) create mode 100644 custom-domains.md diff --git a/custom-domains.md b/custom-domains.md new file mode 100644 index 0000000..1023408 --- /dev/null +++ b/custom-domains.md @@ -0,0 +1,81 @@ +--- +title: 'Using custom domains with LinkTaco services' +description: 'Using custom domains with LinkTaco services' +--- + +LinkTaco is a series of four services (including the API service). For the +three link services paid organizations can use their own domains to serve the +services. + +An example would be to use something like "links.yourdomain.com" instead of +"linktaco.com/your-username". The page and data is the same but using your own +custom domain has quite some benefits. + +# Why use a custom domain? + +In our opinion the biggest reason is to "own" your place on the internet. You +can always migrate off of LinkTaco to another service or your own link listing +by simply changing the DNS records for your custom domain and you're done. You +keep your place. That is very important. + +Other reasons are organization, easy to remember, vanity, and it just looks +cool. + +# Setup your custom domains + +Each paid organization can have up to three custom domains configured. One for +each of the three services that support it. + +Each service has it's own CNAME you can point sub domains to. If you are using +a sub domain (ie, "sub.domain.com") then configuring your sub domain with a +CNAME record is the suggested way to go. + +If you want to use a root domain (ie, "domain.com") then you can not set a +CNAME and you must use an A record. This is problematic for future cases where +we need to move our service(s) to a new IP set, you will also have to update +your DNS record for your domain. Of course we will always provide plenty of +advance notice should this happen. + +Here are the CNAME and IP addresses for each service. + +| Service | CNAME | IP Address | +| ------- | ----- | ---------- | +| Bookmarks | links-cname.linktaco.com | 174.136.99.171 | +| Link Shortening | short-cname.linktaco.com | 174.136.99.172 | +| Link Listings | list-cname.linktaco.com | 174.136.99.173 | + +# Configure LinkTaco for your domains + +You will need to add the DNS record(s) to your domain(s) before configuring +them in LinkTaco. The system will do a DNS verification check and if it is +unable to verify the DNS records are present it will not store the domain +configuration for your organization. + +If your domains are ready, login to your account and do the following: + +1. On the left menu click "Settings" +1. In the settings screen click "Manage Organizations" +1. On the organizations listing, find the organization you want to configure a + domain for and click the "Actions" button. +1. Click the "Domains" option in the drop down menu. +1. Click the "Add" button in the top right. +1. Enter the following fields: + - Name - This is just whatever you want to refer to the domain as. It's only + for your own identification purposes. + - Lookup Name - This is the actual domain name to check. For example, + "links.domain.com" or "domain.com". + - Service - This is the service you want to configure this domain for. The + options are Links (aka Bookmarks), Link Shorts (link shortening) and Link + Listings. +1. Click "Save" + +The system will do a DNS verification check before actually saving the records. +If there is an error you will be notified. Otherwise you will now see the +domain listed for the service you selected. + +You should be able to load the domain configured in your web browser now. Try +typing the domain you setup into your web browser and press enter. The first +time connecting it may take a few seconds as the system will need to generate +the SSL certificate. + +That's it. You're done. diff --git a/index.md b/index.md index cac57f9..2b8fdc8 100644 --- a/index.md +++ b/index.md @@ -8,6 +8,7 @@ description: 'Documentation for the software and usage of LinkTaco' # How to Use LinkTaco - [Getting Started](getting-started.md) +- [Custom Domains](custom-domains.md) # Technical / Development -- 2.45.2