failed-galleries/python-gallery
1
0
Fork 0
mirror of https://github.com/Derpy-Leggies/OnlyLegs.git synced 2025-01-15 11:05:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make guide to installing the app clearer

Browse source
This commit is contained in:
Michał 2023-03-12 18:37:07 +00:00
parent b208b872d7
commit 8496100e7a
1 changed files with 29 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -22,16 +22,15 @@
</div> </div>
## Features ## Features
### Currently implemented - [x] Easy uploading and managing of a gallery of images
- Easy uploading and managing of a gallery of images - [x] Multi user support, helping you manage a whole group of photographers
- Multi user support, helping you manage a whole group of photographers - [x] Image groups, helping you sort your favorite memories
- Image groups, helping you sort your favorite memories - [x] Custom CSS support
- Custom CSS support - [ ] Password locked images/image groups, helping you share photos only to those who you want to
- [ ] Logging and automatic login attempt warnings and timeouts
- [ ] Searching through tags, file names and users
### Coming soon tm And many more planned things!
- Password locked images/image groups, helping you share photos only to those who you want to
- Logging and automatic login attempt warnings and timeouts
- Searching through tags, file names, users (and metadata maybe, no promises)
## screenshots ## screenshots
@ -42,20 +41,35 @@ Image view
![screenshot](.github/images/imageview.png) ![screenshot](.github/images/imageview.png)
## Running ## Running
By default, the app runs on port 5000 with 4 workers, you can pass in arguments to change that, use `-h` or `--help` to see all the options.
Once you clone the repo to your desired location and have installed python `poetry`, install the requirements with the following command: You first need to install `python poetry`, its best to follow their getting started guide you can find on the official website.
Next we need to install the required packages for the gallery to function correctly, make sure you're in the directory of the project when you run this command:
poetry install poetry install
From there you can run the app with Gunicorn using: By default, the app runs on **port 5000**, **4 workers** on `gunicorn` ready for you to use it. You can find more information on this using the `-h` flag. But to run the gallery, use this command.
poetry run python3 run.py poetry run python3 run.py
You can also run the app in debug mode using `-d` or `--debug`, but its best to look into the logs file located under `~/.config/onlylegs/only.log` if you're facing issues of any sorts! Now follow the provided prompts to fill in the information for the Admin account and you're ready to go!
On some systems, especially containers, you may need to set an XDG path for configuration files, you can do this with ### Common issues
#### App failing to create a user config folder
Try checking if you have `XDG_CONFIG_HOME` setup. If you dont, you can set that with this command:
export XDG_CONFIG_HOME="$HOME/.config" export XDG_CONFIG_HOME="$HOME/.config"
## Finall notes
Thank you to everyone who helped me test the previous and current versions of the gallery, especially critters:
- Carty
- Jeetix
- CRT (Mika)
- mrHDash
- Verg
- Fennec
Enjoy using OnlyLegs! Enjoy using OnlyLegs!