Skip to content
This repository has been archived by the owner on Jul 1, 2024. It is now read-only.

Commit

Permalink
docs: custom domain setup
Browse files Browse the repository at this point in the history
  • Loading branch information
eddiejaoude committed Nov 6, 2023
1 parent f1ea98b commit a60cd72
Show file tree
Hide file tree
Showing 6 changed files with 129 additions and 61 deletions.
9 changes: 9 additions & 0 deletions components/layouts/DocsLayout.js
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,15 @@ export const navigation = [
{ name: "Hacktoberfest", href: "/docs/contributing/hacktoberfest" },
],
},
{
name: "Premium",
// icon: ChartPieIcon,
children: [
{ name: "Auto", href: "/docs/premium/auto" },
{ name: "Customisation", href: "/docs/premium/customisation" },
{ name: "Custom Domain", href: "/docs/premium/domain" },
],
},
{
name: "Other",
// icon: ChartPieIcon,
Expand Down
2 changes: 1 addition & 1 deletion pages/account/manage/premium.js
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ export default function ManageSettings({
</div>
<p className="text-sm text-primary-medium-low dark:text-primary-low-high">
Clear and save to remove domain.{" "}
<Link href="/docs/how-to-guides/premium">
<Link href="/docs/premium/domain">
Learn more about custom domains
</Link>
</p>
Expand Down
60 changes: 0 additions & 60 deletions pages/docs/how-to-guides/premium.mdx

This file was deleted.

30 changes: 30 additions & 0 deletions pages/docs/premium/auto.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import DocsLayout from "@components/layouts/DocsLayout.js";
import ClipboardCopy from "@components/ClipboardCopy";
import Link from "@components/Link";
import Alert from "@components/Alert.js";

## Premium Features

If you have a Premium account you have these extra features.

### Premium Badge

Automatically earn a Premium badge. This is shown on your Profile tags.

![Premium Badge example](https://github.com/EddieHubCommunity/BioDrop/assets/624760/b2741e55-7359-4c73-b8bc-8364cba283e5)

### Hidden "Create your BioDrop Profile" button

The "Create your BioDrop Profile" button which is shown on Free accounts for visitors and users that are not logged in, is automatically hidden.

![Create your BioDrop Profile example](https://github.com/EddieHubCommunity/BioDrop/assets/624760/c4e80774-d9f7-4ccd-ab31-ded0c9f43963)

export default ({ children }) => (
<DocsLayout
title="BioDrop Links Documentation"
section="Customising your Profile"
name="Links"
>
{children}
</DocsLayout>
);
22 changes: 22 additions & 0 deletions pages/docs/premium/customisation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import DocsLayout from "@components/layouts/DocsLayout.js";
import ClipboardCopy from "@components/ClipboardCopy";
import Link from "@components/Link";
import Alert from "@components/Alert.js";

## Hide Navbar and Footer

You can use the toggles to hide/show the Navbar and Footer from your Profile.

To apply these changes click on the `Save` button.

![Hide/Show Navbar and Footer](https://github.com/EddieHubCommunity/BioDrop/assets/624760/6a5cef77-f84c-403c-85f5-840b91a1379f)

export default ({ children }) => (
<DocsLayout
title="BioDrop Links Documentation"
section="Customising your Profile"
name="Links"
>
{children}
</DocsLayout>
);
67 changes: 67 additions & 0 deletions pages/docs/premium/domain.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
import DocsLayout from "@components/layouts/DocsLayout.js";
import ClipboardCopy from "@components/ClipboardCopy";
import Link from "@components/Link";
import Alert from "@components/Alert.js";

## Custom Domain

<Alert
type="warning"
message={
<>
<strong>NOTE: </strong>
When using your custom domain, the Navbar and Footer will be hidden by default.
</>
}
/>

Customise even further by using your own domain for your BioDrop Profile.

### 1. Go to your domain registrar

(for example: Namecheap, GoDaddy, Google Domains, 123Reg etc).

You will need to update your domain's DNS to point to BioDrop.

You can do this by adding an `A` record for your apex domain `@` that points to `76.76.21.21`.

<Alert
type="warning"
message={
<>
<strong>NOTE: </strong>
These changes can take up to 48 hours to have an effect.
</>
}
/>

![DNS screenshot](https://github.com/EddieHubCommunity/BioDrop/assets/624760/cc5e696a-8c98-4aa2-b92d-1d5c4d68ef18)

### 2. Add your domain to BioDrop

In the Premium tab on the "Create & Manage your Profile", add the domain you want to use in the `input` form field.

![Premium Page example](https://github.com/EddieHubCommunity/BioDrop/assets/624760/468d3be0-e8c2-4be2-85d5-26436c8aa0ab)

### Common errors

We use Vercel and if you are using the same domain on Vercel already this will cause an error. For example if you want to add these subdomains to your BioDrop Profile `bio.foo.bar` or `contact.foo.bar`

To fix this please follow these steps:

1. If you have already added your custom domain to BioDrop, remove the custom domain `bio.foo.bar` from BioDrop's input domain field.
2. Then on Vercel add `foo.bar` and follow the instructions on Vercel.
3. Then on BioDrop domain input field add `bio.foo.bar`.
4. You will have to set a TXT record in your DNS to prove ownership of the domain

![Vercel domain error](https://github.com/EddieHubCommunity/BioDrop/assets/624760/f86b2d00-c583-4d24-bb13-175d678b7360)

export default ({ children }) => (
<DocsLayout
title="BioDrop Links Documentation"
section="Customising your Profile"
name="Links"
>
{children}
</DocsLayout>
);

0 comments on commit a60cd72

Please sign in to comment.