Skip to content

Commit

Permalink
Merge pull request #15 from hozza:patch-1
Browse files Browse the repository at this point in the history
improve README.md a little
  • Loading branch information
0x2E committed Aug 24, 2024
2 parents 8a25ffa + b35cf9a commit 4d22dbe
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Fusion

A lightweight RSS feed aggregator and reader.

![preview](./assets/screenshot.png)

Fusion is an RSS aggregator and reader with:
Key features include:

- Group, Bookmark, Search, Sniff feeds automatically, Import/Export OPML file
- Group, Bookmark, Search, Sniff feeds automatically
- Import/Export OPML file
- Support RSS, Atom, JSON types feed
- Responsive, Light/Dark mode, PWA
- Lightweight, Self-hosted friendly
Expand All @@ -16,12 +19,34 @@ Fusion is an RSS aggregator and reader with:

### 1. Docker

Choose Docker CLI or Docker Compose examples below:

#### 1.a. Docker CLI

```shell
docker run -it -d -p 8080:8080 -v $(pwd)/fusion:/data \
-e PASSWORD="123456" \
-e PASSWORD="rss123456" \
rook1e404/fusion
```

#### 1.b. Docker Compose

```compose
version: '3'
services:
fusion:
image: rook1e404/fusion
ports:
- '127.0.0.1:8080:8080'
environment:
- PASSWORD=rss123456
restart: "unless-stopped"
volumes:
- ./data:/data
```

Change `./data` to where you want the files stored. Remember to specify localhost IP unless you want Docker exposing the port though your firewall. Then, in the same directory as this `compose.yml` file run `docker compose up -d` (or `docker-compose up -d` on older versions).

### 2. Pre-built binary

Download from [Releases](https://github.com/0x2E/fusion/releases).
Expand Down

0 comments on commit 4d22dbe

Please sign in to comment.