summaryrefslogtreecommitdiff
path: root/microservices/01-oauth2-server/linux/deb/README
diff options
context:
space:
mode:
authorKamal Wickramanayake <kamal@inbox.lk>2026-07-03 21:10:32 +0530
committerKamal Wickramanayake <kamal@inbox.lk>2026-07-03 21:10:32 +0530
commita0f3f5a069153c46ac3a85fa75c3ec50fea6ea99 (patch)
tree6e97c9b87c314a8a64a25d3ffe10e710db1740fc /microservices/01-oauth2-server/linux/deb/README
parentaa122113ade36f02dc8fdbebdf1232b5c4b8742c (diff)
Added Linux deb file creation scripts and build-all.sh
Diffstat (limited to 'microservices/01-oauth2-server/linux/deb/README')
-rw-r--r--microservices/01-oauth2-server/linux/deb/README59
1 files changed, 59 insertions, 0 deletions
diff --git a/microservices/01-oauth2-server/linux/deb/README b/microservices/01-oauth2-server/linux/deb/README
new file mode 100644
index 0000000..a9b2810
--- /dev/null
+++ b/microservices/01-oauth2-server/linux/deb/README
@@ -0,0 +1,59 @@
+This directory contains everything to build a deb package that bundles a Spring Boot app that starts a web server.
+
+####
+
+Executable scripts:
+
+ create-new-project.sh - This script can be used to create a new deb package project similar to this project that uses a different name (than ceit-fs-auth-server). Output will be placed inside 'out' directory.
+
+ build.sh - This script builds the deb package. If the above script is used, go to the corresponding directory inside out directory to find a copy of this build.sh script.
+
+####
+
+To create a new deb package project that uses 'mycompany-myapp' as the name, run the following command:
+
+ ./create-new-project.sh mycompany mycompany-myapp
+
+ The newly generated project files will be found inside the out directory.
+
+####
+
+To build, run the following command:
+
+ ./build.sh
+
+ Note that the Spring Boot application has not been bundled with this. You need to build it seperately and put it in the correct directory (run build.sh for further details).
+
+####
+
+To install the build deb package run the following commands replacing the package.deb with the correct name of the deb file.
+
+ cp package.deb /tmp
+ cd /tmp
+ apt install ./package.deb
+
+The above "apt install" will download dependencies if needed. Otherwise, dpkg command can just be used to install or upgrade the package:
+
+ dpkg -i package.deb
+
+After installing the package, update the configuration file /etc/ceit-fs-auth-server/application.yaml .
+
+Enable service to start at boot time:
+
+ systemctl enable ceit-fs-auth-server
+
+Start service:
+
+ systemctl start ceit-fs-auth-server
+
+View service log:
+
+ journalctl -u ceit-fs-auth-server -f
+
+ (Press CTRL+C to terminate log viewing)
+
+Access the service:
+
+ http://server-ip-or-hostname:8085/
+
+ (Instead of 8085, use the port configured in application.yaml file)