From a0aef2d5a584520c9a539c9261741aac1288f8f9 Mon Sep 17 00:00:00 2001 From: Rostislav Raykov Date: Wed, 9 Oct 2024 17:04:59 +0300 Subject: [PATCH] updated README.md --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c508047..9b7770d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![Build Status](https://jenkins.tyron.rocks/buildStatus/icon?job=quickdrop)](https://jenkins.tyron.rocks/job/quickdrop) + # QuickDrop QuickDrop is an easy-to-use file sharing application that allows users to upload files without an account, @@ -40,7 +41,48 @@ protection. ### Installation -- Instructions coming soon when the project is ready for deployment. +**Installation without Docker** + +1. Clone the repository: + +``` +git clone https://github.com/RoastSlav/quickdrop.git +cd quickdrop +``` + +2. Build the application: + +``` +mvn clean package +``` + +3. Run the application: + +``` +java -jar target/quickdrop-0.0.1-SNAPSHOT.jar +``` + +4. Using an external application.properties file: + - Create an **application.properties** file in the same directory as the JAR file or specify its location in the + start command. + + - Add your custom settings, for example (Listed below are the default values): + +``` +spring.servlet.multipart.max-file-size=1024MB +spring.servlet.multipart.max-request-size=1024MB +server.tomcat.connection-timeout=60000 +file.save.path=files +file.max.age=30 (In days) +logging.file.name=log/quickdrop.log +file.deletion.cron=0 0 2 * * * +``` + +- Run the application with the external configuration: + +``` +java -jar target/quickdrop-0.0.1-SNAPSHOT.jar --spring.config.location=./application.properties +``` ## License