Cutlery/Kavita
1
0
Fork 0
mirror of https://github.com/Kareadita/Kavita.git synced 2025-07-09 03:04:19 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#130)

Browse Source 
Added docker link
This commit is contained in:
Joseph Milazzo 2021-03-30 08:40:41 -05:00 committed by GitHub
parent 935bb83957
commit 3aac081266
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -18,19 +18,22 @@ your manga collection with your friends and family!
* Ability to manage users, access, and ratings * Ability to manage users, access, and ratings
## How to Build ## How to Build
1. Ensure you've cloned Kavita-webui. You should have Projects/Kavita and Projects/Kavita-webui - Ensure you've cloned Kavita-webui. You should have Projects/Kavita and Projects/Kavita-webui
2. In Kavita-webui, run ng serve. This will start the webserver on localhost:4200 - In Kavita-webui, run ng serve. This will start the webserver on localhost:4200
3. Run API project in Kavita, this will start the backend on localhost:5000 - Run API project in Kavita, this will start the backend on localhost:5000
## How to Deploy ## How to Deploy
- Run build.sh and pass the Runtime Identifier for your OS or just build.sh for all supported RIDs. - Run build.sh and pass the Runtime Identifier for your OS or just build.sh for all supported RIDs.
## How to install ## How to install
1. Unzip the archive for your target OS - Unzip the archive for your target OS
2. Place in a directory that is writable. If on windows, do not place in Program Files - Place in a directory that is writable. If on windows, do not place in Program Files
3. Open appsettings.json and modify TokenKey to a random string ideally generated from [https://passwordsgenerator.net/](https://passwordsgenerator.net/) - Open appsettings.json and modify TokenKey to a random string ideally generated from [https://passwordsgenerator.net/](https://passwordsgenerator.net/)
4. Run Kavita - Run Kavita
## Docker
- Docker is supported and tested, you can find the image and instructions [here](https://github.com/Kizaing/KavitaDocker).
## Buy me a beer ## Buy me a beer
I've gone through many beers building Kavita and expect to go through many more. If you want to throw me a few bucks you can [here](https://paypal.me/majora2007?locale.x=en_US). Money will go I've gone through many beers building Kavita and expect to go through many more. If you want to throw me a few bucks you can [here](https://paypal.me/majora2007?locale.x=en_US). Money will go