https://github.com/unmade/shelf-showcase

An example of Shelf Cloud ready-to-run docker-compose
https://github.com/unmade/shelf-showcase

Last synced: 16 days ago
JSON representation

An example of Shelf Cloud ready-to-run docker-compose

• Host: GitHub
• URL: https://github.com/unmade/shelf-showcase
• Owner: unmade
• License: agpl-3.0
• Created: 2022-02-19T16:54:35.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-02-23T19:48:06.000Z (9 months ago)
• Last Synced: 2024-07-31T08:16:07.833Z (4 months ago)
• Homepage: https://getshelf.cloud
• Size: 33.2 KB
• Stars: 288
• Watchers: 7
• Forks: 7
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shelf Showcase

An example of ready-to-run docker-compose for the Shelf App

![App Preview Light Theme](https://i.imgur.com/Hu8IJkE.png)

![App Preview Dark Theme](https://i.imgur.com/7qtplKF.png)

## Quickstart

To start the application simply run:

```bash

docker compose up

```

Then open it in your browser:

```bash

http://localhost:8080

```

> If you're running it on the remote machine consider to update `API_BASE_URL`

> in the [docker-compose.yml](./docker-compose.yml) from localhost to the LAN IP

> of your docker host.

By default there is a superuser created when you run the project for the first

time with the default credentials:

- username: **admin**

- password: **root**

You can find more in the following repo:

- [https://github.com/unmade/shelf-back](https://github.com/unmade/shelf-back)

- [https://github.com/unmade/shelf-front](https://github.com/unmade/shelf-front)

## Re-indexing existing file in the storage

Sometime it is easier to put all your files into the storage and then reindex

them instead of manually uploading via web.

In order to do so, first put the files into corresponding user folder in the storage.

For example, if you have a user `admin`, then put files into `./shelf-data/admin`.

After that run the command:

```bash

docker compose exec shelf-back python manage.py reindex 

docker compose exec shelf-back python manage.py reindex-content 

```

The first command will simply add all files in the storage to the database, so

you'll see them on the UI as soon as possible.

The second command extract some metadata, such as EXIF, from target files. It

can take some, especially if you have lots of media files.