Skip to content

Commit

Permalink
Merge pull request #52 from YeeJiaWei/main
Browse files Browse the repository at this point in the history
add instruction for minimal docker
  • Loading branch information
daniel31x13 authored Jan 12, 2025
2 parents e15ae53 + fafc0ff commit 667eed1
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions docs/self-hosting/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,27 @@ Here you can find everything you need to setup a fully fledged Linkwarden instan

### Hardware Requirements

Linkwarden has pretty minimal hardware requirements - it was tested on a 2gb VPS and it ran pretty smoothly, the most intense part is when you build the app, but once it's running it's relatively lightweight.
Linkwarden has pretty minimal hardware requirements - it was tested on a VPS with 4gb of memory and it ran pretty smoothly, the most intense part is when you build the app, but once it's running it's relatively lightweight.

### Docker Compose 🐋
### Docker 🐋

**Requirements:**

- Docker
- Git
- Curl

#### 1. Clone the Linkwarden repository
##### 1. Download the required files

```bash
$ git clone https://github.com/linkwarden/linkwarden.git
mkdir linkwarden && cd linkwarden
curl -O https://raw.githubusercontent.com/linkwarden/linkwarden/refs/heads/main/docker-compose.yml
curl -L https://raw.githubusercontent.com/linkwarden/linkwarden/refs/heads/main/.env.sample -o ".env"
```

#### 2. Configure the Environment Variables
##### 2. Configure the Environment Variables

```bash
$ cd linkwarden
$ cp .env.sample .env
$ nano .env
nano .env
```

The required environment variables are:
Expand All @@ -55,12 +55,12 @@ The only thing you MUST change here is `NEXTAUTH_SECRET` and `POSTGRES_PASSWORD`

The `NEXTAUTH_URL` should be changed to your domain name _only if you are hosting it somewhere else_.

#### 3. Run it!
##### 3. Run it!

In the main folder (where you created the .env file) simply run the following:

```bash
$ docker compose up
docker compose up
```

After a few minutes (depending on your internet connection) you can access Linkwarden via [http://localhost:3000](http://localhost:3000) (or whichever hostname you deployed Linkwarden on).
Expand All @@ -86,23 +86,23 @@ The Manual Installation is targeted towards a more technical audience, to take a
#### 1. Clone the Linkwarden repository

```bash
$ git clone https://github.com/linkwarden/linkwarden.git
$ cd linkwarden
git clone https://github.com/linkwarden/linkwarden.git
cd linkwarden
```

#### 2. Install the necessary dependancies

```bash
$ yarn
$ npx playwright install --with-deps chromium
yarn
npx playwright install --with-deps chromium
```

#### 3. Configure the Environment Variables

```bash
$ cd linkwarden
$ cp .env.sample .env
$ nano .env
cd linkwarden
cp .env.sample .env
nano .env
```

The required environment variables are:
Expand All @@ -120,14 +120,14 @@ The `NEXTAUTH_URL` should be changed to your domain name _only if you are hostin
#### 4. Build and setup the database:

```bash
$ yarn build
$ yarn prisma migrate deploy
yarn build
yarn prisma migrate deploy
```

#### 5. Start the app:

```bash
$ yarn start
yarn start
```

### Troubleshooting
Expand All @@ -147,7 +147,7 @@ There are a few common issues that you might encounter when setting up Linkwarde
This error is caused by the `@prisma/client` package not being installed correctly, to fix it, simply run:

```bash
$ yarn prisma generate
yarn prisma generate
```

</details>

0 comments on commit 667eed1

Please sign in to comment.