docs(setup): Add setup docs and easy install script by deo002 · Pull Request #160 · fossology/LicenseDb

deo002 · 2025-08-22T08:12:19Z

Changes

Add clear set up docs for different ways to run the project
Add easy install script
Improve README.

Submitter Checklist

Includes tests (if there is a feature changed/added)
Includes docs ( if changes are user facing)
I have tested my changes locally.

avinal

Looks good, some changes required.

avinal · 2025-09-10T08:07:14Z

+	datafile = flag.String("datafile", "licenseRef.json", "(optional) path of the file from which licenses are to be imported")
 	// auto-update the database
-	populatedb = flag.Bool("populatedb", false, "boolean variable to update database")
+	populatedb = flag.Bool("populatedb", false, "(optional) boolean variable to populate database with licences, obligation types and classifications on start up")


Suggested change

populatedb = flag.Bool("populatedb", false, "(optional) boolean variable to populate database with licences, obligation types and classifications on start up")

populatedb = flag.Bool("populatedb", false, "(optional) boolean variable to populate database with licenses, obligation types and classifications on start up")

Can safely ignore. Both are correct spellings, just in different regions. 😅

avinal · 2025-09-10T08:10:12Z

+ADMIN_USER="fossy_super_admin"
+ADMIN_PASS="fossy_super_admin"
+ADMIN_DISPLAY="fossy_super_admin"
+ADMIN_EMAIL="fossy_super_admin@licensedb.org"


Suggested change

ADMIN_EMAIL="fossy_super_admin@licensedb.org"

ADMIN_EMAIL="fossy_super_admin@example.org"

I would not use a domain that we do not own. Use example domains if required.

avinal · 2025-09-10T08:17:09Z


- Create the `external_ref_fields.yaml` file in the root directory of the project and change the
-  values of the extra license json keys as per your requirement.
+### 3. Install golang-migrate CLI


Please add the command/script or refer to the repository.

The instructions are under a wrong header; please fix.

avinal · 2025-09-10T08:17:29Z

+### 4. Install swagger document generator

- Generate Go struct for the extra fields listed in the external_ref_fields.yaml.
+You'll need```swag``` installed to build swagger docs.


Suggested change

You'll need```swag``` installed to build swagger docs.

You'll need ```swag``` installed to build swagger docs.

avinal · 2025-09-10T08:18:33Z

+#### For Linux & macOS

 ```bash
-go build ./cmd/laas
-```
-
- Create the `.env` file in the root directory of the project and change the
-  values of the environment variables as per your requirement.
-
-```bash
-cp configs/.env.dev.example .env
-vim .env
-```
-
- Run the migration files.
-```bash
-migrate -path pkg/db/migrations -database "postgres://fossy:fossy@localhost:5432/licensedb?sslmode=disable" up
-```
-
- Run the executable.
-
-```bash
-./laas
-```
-
- You can directly run it by the following command.
-
-```bash
-go run ./cmd/laas
+curl -L https://github.com/golang-migrate/migrate/releases/latest/download/migrate.linux-amd64.tar.gz | tar xvz
+sudo mv migrate /usr/local/bin/
 ```

-### Create first user
-Connect to the database using `psql` with the following command.
-```bash
-psql -h localhost -p 5432 -U fossy -d licensedb
-```
+For other platforms and installation methods, check the official docs:
+👉 [https://github.com/golang-migrate/migrate](https://github.com/golang-migrate/migrate)


I believe this needs to go under step 3.

avinal · 2025-09-10T08:20:27Z

+- Build the app image
+
+```bash
+docker build -t licensedb/latest


I think the reference to the Dockerfile and the context is missing. Please check.

There are some things that need to be changed in the docker file. We have another PR open for that. We'll add the details here once it is merged.

avinal · 2025-09-10T08:22:29Z

+
+### 2. Setting up the database
+
+- Create database licensedb and provide user fossy all priviliges to it.


Suggested change

- Create database licensedb and provide user fossy all priviliges to it.

- Create database licensedb and provide user fossy all privileges to it.

avinal · 2025-09-10T08:24:15Z

+      swag fmt --generalInfo ./pkg/api/api.go --dir ./pkg/api,./pkg/auth,./pkg/db,./pkg/models,./pkg/utils
+      ```
+
+- The super admin user can only create new app users and import licenses and obligations.


Suggested change

- The super admin user can only create new app users and import licenses and obligations.

- Only the super admin user can create new app users, import licenses and obligations.

Kaushl2208

Hey @deo002 , I think we dont need the easy script part anymore. It was planned when both frontend and backend setup was discussed.

We should push for Docker and Bare Metal installation. Operationally this will lag behind otherwise.

Other point is: If we are removing the setup guide from README, We should also add some of the other things that should be there in a README. Like project description. Features and Functionalities etc etc.
Basic Testing and running steps (With Docker) can also be mentioned in the README. Link all the other documents that we have in the projects. Like Contributing & Setup(bare metal)

I like the ER Diagram idea, but it doesnt load anymore.

Kaushl2208 · 2026-09-23T07:45:32Z

 TOKEN_HOUR_LIFESPAN=1
 # Secret key to sign tokens (openssl rand -hex 32)
-API_SECRET=some-random-string
+API_SECRET=0195067722c9213eee87c3db9b087ade


do we need to type a SECRET looking string in API_SECRET? Can we put these steps in README? Setup guide? Like how to generate and what variable to update?

Kaushl2208 · 2026-09-23T07:45:38Z

 # refresh token information(30 days)
 REFRESH_TOKEN_HOUR_LIFESPAN=720
-REFRESH_TOKEN_SECRET=some-other-random-string
+REFRESH_TOKEN_SECRET=d78cded51eff6ab87e255b8f72f2215c


Kaushl2208 · 2026-09-23T07:47:15Z

+# SPDX-FileCopyrightText: 2025 Dearsh Oberoi <dearsh.oberoi@siemens.com>
+# SPDX-License-Identifier: GPL-2.0-only
+
+set -euo pipefail


I am not sure about creating one more setup mechanism. We already have something similar to this for Docker.

Kaushl2208 · 2026-09-23T07:47:34Z

+# add the same yaml file to your frontend project
+


Added a line regarding this in the Post Install section of SETUP.md

Kaushl2208 · 2026-09-23T07:49:38Z

-### Option 2: Run with Docker Compose (recommended)
-
-A `docker-compose.yml` is included in this repository to make it easy to spin up LicenseDB along with PostgreSQL.
+You'll need ```swag``` installed to build swagger docs.


If we are creating a separate guide for setup, That information should exclusively be there.

Kaushl2208 · 2026-09-23T07:50:22Z

-    ```
+👉 Please follow the [Setup Guide](./SETUP.md) for step-by-step instructions on how to run the project.

 ### Testing (local)


This also then belong to setup.md then

Kaushl2208 · 2026-09-23T07:51:20Z

+## 1. Easy Install Script
+
+The easiest of them all is via the easy install script.
+
+- (Optional) Edit the ```configs/.env.dev.example``` to set the environment variables. If not done, default values will be taken.
+
+- (Optional) Edit the ```external_ref_fields.example.yaml``` to extend the schema of licenses and obligations with custom fields. If not done, default values will be taken.
+
+- Run the easy install script to generate the app binary.
+
+```bash
+./easy_install.sh
+```
+
+- Run the executable
+
+```bash
+./laas
+```
+
+Use the command below for more startup options.
+
+```bash
+./laas --help
+```


Nope, This should not be the primary way for the installation. I dont think this should even be a way altogether

Kaushl2208 · 2026-09-23T07:52:22Z

+```bash
+docker build -t licensedb/latest .
+```


We can also mention the DockerHub/GHCR image where we push some of the latest builds.

Signed-off-by: deo002 <oberoidearsh@gmail.com>

Kaushl2208

Looks good.

deo002 force-pushed the docs/setup branch from 939c13a to b41b32d Compare August 22, 2025 08:15

deo002 added needs test needs code review labels Aug 22, 2025

deo002 force-pushed the docs/setup branch from b41b32d to 47a515a Compare September 9, 2025 05:34

avinal suggested changes Sep 10, 2025

View reviewed changes

deo002 force-pushed the docs/setup branch from 47a515a to 7a893af Compare September 17, 2025 09:35

deo002 requested a review from avinal September 17, 2025 09:35

deo002 force-pushed the docs/setup branch from 7a893af to f6d6f25 Compare September 17, 2025 09:40

deo002 force-pushed the docs/setup branch 2 times, most recently from 0bf9ee9 to 51e9d37 Compare February 10, 2026 06:17

deo002 requested a review from Kaushl2208 February 10, 2026 06:19

deo002 mentioned this pull request Feb 10, 2026

Add Makefile for streamlined setup, migration, and test execution #195

Closed

deo002 force-pushed the docs/setup branch from 51e9d37 to a1dca0a Compare September 22, 2026 09:49

Kaushl2208 requested a review from GMishx September 22, 2026 10:56

Kaushl2208 requested changes Sep 23, 2026

View reviewed changes

deo002 force-pushed the docs/setup branch 2 times, most recently from 34270e8 to c295fa7 Compare September 24, 2026 06:21

docs(setup): add setup docs and easy install script

d1d044f

Signed-off-by: deo002 <oberoidearsh@gmail.com>

deo002 force-pushed the docs/setup branch from c295fa7 to d1d044f Compare September 24, 2026 06:41

deo002 requested a review from Kaushl2208 September 24, 2026 06:41

Kaushl2208 approved these changes Oct 1, 2026

View reviewed changes

Kaushl2208 merged commit 14c88bf into fossology:main Oct 1, 2026
8 checks passed

	populatedb = flag.Bool("populatedb", false, "(optional) boolean variable to populate database with licences, obligation types and classifications on start up")
	populatedb = flag.Bool("populatedb", false, "(optional) boolean variable to populate database with licenses, obligation types and classifications on start up")

	ADMIN_EMAIL="fossy_super_admin@licensedb.org"
	ADMIN_EMAIL="fossy_super_admin@example.org"

	You'll need```swag``` installed to build swagger docs.
	You'll need ```swag``` installed to build swagger docs.


		### 2. Setting up the database

		- Create database licensedb and provide user fossy all priviliges to it.

	- The super admin user can only create new app users and import licenses and obligations.
	- Only the super admin user can create new app users, import licenses and obligations.

Conversation

deo002 commented Aug 22, 2025

Changes

Submitter Checklist

Uh oh!

avinal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kaushl2208 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kaushl2208 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Kaushl2208 left a comment •

edited

Loading