Update environment variables in .env file and enhance README with setup instructions

README.md

@@ -0,0 +1,67 @@
+# Linkwarden Personal Fork
+
+This is a personal fork of Linkwarden, a self-hosted bookmark manager to organize and archive links. This fork is customized for personal use with Docker.
+
+## Prerequisites
+
+- Docker
+- Docker Compose
+
+## Setup
+
+1. Clone the repository:
+    ```sh
+    git clone https://github.com/yourusername/linkwarden.git
+    cd linkwarden
+    ```
+
+2. Create a `.env` file in the root directory and configure the necessary environment variables. You can use the provided `.env` file as a reference.
+
+3. Start the services using Docker Compose:
+    ```sh
+    docker-compose -f linkwarden.yml up -d
+    ```
+
+## Configuration
+
+### Environment Variables
+
+The `.env` file contains various configuration options. Below are some key variables:
+
+- `NEXTAUTH_URL`: The URL for NextAuth authentication.
+- `NEXTAUTH_SECRET`: Secret for NextAuth.
+- `DATABASE_URL`: Database connection URL.
+- `POSTGRES_PASSWORD`: Password for the PostgreSQL database.
+- `NEXT_PUBLIC_*`: Various public settings for different integrations.
+
+### Volumes
+
+- `./pgdata`: Stores PostgreSQL data.
+- `./data`: Stores Linkwarden data.
+
+## Usage
+
+Access the Linkwarden application at `http://localhost:5000`.
+
+## Customization
+
+To customize the application, you can modify the source code and rebuild the Docker image:
+
+1. Uncomment the `build` line and comment the `image` line in `linkwarden.yml`:
+    ```yaml
+    # build: . # uncomment this line to build from source
+    image: ghcr.io/linkwarden/linkwarden:latest # comment this line to build from source
+    ```
+
+2. Rebuild and restart the services:
+    ```sh
+    docker-compose -f linkwarden.yml up --build -d
+    ```
+
+## Contributing
+
+This fork is intended for personal use. If you have any suggestions or improvements, feel free to fork and modify it.
+
+## License
+
+This project is licensed under the MIT License.