KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

linkin

★ 85 Open GitHub ↗

Linkin is a customizable self hosted link tree platform.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Linkin &middot; [![DeepScan grade](https://deepscan.io/api/teams/14086/projects/17178/branches/386441/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=14086&pid=17178&bid=386441) [![codecov](https://codecov.io/gh/RizkyRajitha/linkin/branch/master/graph/badge.svg?token=DPE3YVUYUW)](https://codecov.io/gh/RizkyRajitha/linkin) ![license](https://img.shields.io/github/license/rizkyrajitha/linkin??style=plastic) [![Code Coverage](https://github.com/RizkyRajitha/linkin/actions/workflows/coverage.yml/badge.svg?branch=master)](https://github.com/RizkyRajitha/linkin/actions/workflows/coverage.yml)

## Linkin is a customizable self-hosted link tree application.

### Free and Open Source 💯

### Self Hosted, you own your data 💽

### Customize your link tree with few clicks using a feature-rich dashboard 🤖

### SEO friendly design built using Next js 🕸️

### Supports one-click deploy using multiple cloud providers 🚀

[View Demo](http://linkindemo.vercel.app/)
 
[Demo Admin](http://linkindemo.vercel.app/admin)
`http://linkindemo.vercel.app/admin`

- Demo username = `admin`
- Demo password = `linkin123`

## Deploy with Vercel

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FRizkyRajitha%2Flinkin&env=DATABASE_URL%2CHASHSALT%2CNODE_ENV)

## Deploy with Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/RizkyRajitha/linkin)

## Deploy with Railway

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template?template=https%3A%2F%2Fgithub.com%2FRizkyRajitha%2Flinkin&plugins=postgresql&envs=HASHSALT%2CPORT%2CRAILWAY&HASHSALTDesc=Random+secret+HASHSALT+for+JWT+and+password+encryption&PORTDesc=Exposed+Port+in+Dockerfile&RAILWAYDesc=migrate+and+seed+the+database+in+railway+.+done+in+docker+image+build+time&PORTDefault=3000&RAILWAYDefault=1)

![Screenshot_2021-05-22 LinkIn's Link tree Page](https://user-images.githubusercontent.com/38534289/119221911-4ca94f80-bb0f-11eb-94ff-31f1c3a51d06.png)

![Screenshot_2021-05-22 Linkin Dashboard](https://user-images.githubusercontent.com/38534289/119221942-7d898480-bb0f-11eb-9175-5e139fa57f0a.png)

![Screenshot_2021-05-22 Linkin Dashboard](https://user-images.githubusercontent.com/38534289/119221939-7c585780-bb0f-11eb-944f-514beb5573b7.png)

## Getting started

- Deploy in Vercel
  - set environment variables
    - `DATABASE_URL` - **Postgres** database url
    - `HASHSALT` - random secret key
    - `NODE_ENV` - set NODE_ENV to `production`
  - after successfully deploying visit `youdomain/admin` to view admin login
  - use default login credentials
    - username = `admin`
    - password = `linkin123`
  - after a successfull login you will be able to see above admin dashboard.

- Deploy in Heroku
 - set environment variables
 - `DATABASE_URL` - **Postgres** database url
 - `HASHSALT` - random secret key
 - after successfully deploying visit `youdomain/admin` to view admin login
 - use default login credentials
 - username = `admin`
 - password = `linkin123`
 - after a successfull login you will be able to see above admin dashboard.

- Deploy in Railway
 - set environment variables
 - `HASHSALT` - random secret key
 - `PORT` - 3000
 - `RAILWAY` - Set to `1` to run migrations and seeding in docker build stage . set `0` to avoid migrations and seeding in docker build stage
 - `DATABASE_URL` - **Postgres** database url . use this variable **if you are not using** railway postgres plugin
 - after successfully deploying visit `youdomain/admin` to view admin login
 - use default login credentials
 - username = `admin`
 - password = `linkin123`
 - after a successfull login you will be able to see above admin dashboard.

## Running with docker

- clone repository or download [docker-compose.yaml](https://raw.githubusercontent.com/RizkyRajitha/linkin/master/docker-compose.yml) yml file
- update image to if you dont have it locally like below.

```yml
  services:
  linkin:
    image: ghcr.io/rizkyrajitha/linkin:latest
    ports:
      - "3000:3000"
    environment:
      DATABASE_URL: "postgres://linkin:linkin123@db:5432/linkin"
      HASHSALT: "1234" # random secret key
      NODE_ENV: "production"
    depends_on:
      - migrate

migrate:
    image: ghcr.io/rizkyrajitha/linkin:latest
    command: >
      sh -c "npm run prismamigrateprod
      && npm run seed"
    environment:
      DATABASE_URL: "postgres://linkin:linkin123@db:5432/linkin"
      HASHSALT: "123" # random secret key
      NODE_ENV: "production"
  ```

- Run `docker compose up -d` to start linkin (this will apply all migrations and then start linkin container).

### Database connection

- if the postgres database is behind pgbounce use `pgbouncer=true` parameter in `DATABASE_URL` ex - `postgres://xx:xxx@xxxx:5432/xxxx?pgbouncer=true`

## Developing locally

#### Requirements

- Node.js 18.x or newer
- Postgresql

#### Clone and install dependencies

```bash
git clone https://github.com/RizkyRajitha/linkin.git
cd linkin
npm i
```

Setup local environmrnt variables in `.env`

example `.env` file

```
DATABASE_URL=postgres://linkin:123@localhost:5432/linkin
HASHSALT=123
```

#### Database migration

create database relations with prisma migration

**you must have Postgres database setup locally**

```bash
npx prisma migrate dev
```

#### Database Seeding

Addign Initial data to the database to get you started

```bash
npm run seed
```

#### Run

```
npm run dev
```

### Build with

- [Next.Js](https://nextjs.org/) .
- [Postgres](https://www.postgresql.org/) .
- [Prisma](https://www.prisma.io/) .

### Currently supported hosting in

- [Vercel](https://vercel.com/) .
- [Heroku](https://heroku.com/) .
- [railway](https://railway.app/) .

### Community

Join our discord community for questions and updates

https://discord.gg/Jsmc5Dm9wg

linkin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README