Skip to content

Commit

Permalink
Updated README.md with SQLite
Browse files Browse the repository at this point in the history
  • Loading branch information
SimplyBoo6 committed Jan 13, 2024
1 parent a3b8050 commit f593109
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 11 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- Automatic image clone detection and viewer using perceuptual hashing.
- Playlists
- Download with gallery-dl or youtube-dlp
- Support for SQLite (default) and MongoDB

## Quick-Start

Expand Down Expand Up @@ -60,7 +61,7 @@ The server can be run as a Docker instance. It accepts the following environment
- (optional) USERNAME - A username to login with. PASSWORD also required.
- (optional) PASSWORD - A password to login with. USERNAME required too.
- (optional) PORT - A port for the Docker instance to expose. Default 3523.
- (optional) DATABASE - Must be set to `mongodb` (default).
- (optional) DATABASE - Either `sqlite` (default) or `mongodb`. SQLite DB is created in the cache dir and called vimtur.db.
- If using `mongodb` then you must also set `DATABASE_URI` to a MongoDB connection string (eg `mongodb://localhost`) and `DATABASE_DB` to the database name.

Note: Any of these variables can be used when starting the NodeJS app natively.
Expand Down
10 changes: 0 additions & 10 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,13 @@ version: '3'
services:
vimtur:
image: simplyboo6/vimtur:5
# build:
# context: .
# dockerfile: Dockerfile.pre
environment:
- CACHE_PATH=/cache/
- DATA_PATH=/data/
- USERNAME
- PASSWORD
- DATABASE=mongodb
- DATABASE_URI=mongodb://mongo
- DATABASE_DB=vimtur
volumes:
- ${DATA_DIR}:/data/
- ${CACHE_DIR}:/cache/
ports:
- '${PORT}:3523'
mongo:
image: mongo
volumes:
- ${CACHE_DIR}/mongo:/data/db

0 comments on commit f593109

Please sign in to comment.