docs(setup): Add setup docs and easy install script #160

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

cmd/laas/main.go

+	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

easy_install.sh

+ADMIN_USER="fossy_super_admin"
+ADMIN_PASS="fossy_super_admin"
+ADMIN_DISPLAY="fossy_super_admin"
+ADMIN_EMAIL="[email protected]"


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:14:23Z

easy_install.sh

The script looks good. Since you have added prompts to show success, I would recommend adding error handling too. What happens if some step fails? We have to let the user know and stop the script. It should not be too hard; we just have to check the output/process at the end of each step and advance the script.

i have set the relevant flags in this line: set -euo pipefail
This should be enough?

-e: exit immediately if any command in script fails
-u: treat unset env variables as error and exit immediately
-o pipefail: exit immediately if a command in the command chain(cmd1 | cmd2 | cmd3) fails

Yes they are good. I just wanted to be as verbose as the other status message. Good for now I guess.

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

README.md


- 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

README.md

+### 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

README.md

+#### 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

SETUP.md

+- 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

SETUP.md

+
+### 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

SETUP.md

+      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.

Signed-off-by: deo002 <[email protected]>

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

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

f6d6f25

Signed-off-by: deo002 <[email protected]>

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

	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.

docs(setup): Add setup docs and easy install script #160

Are you sure you want to change the base?

docs(setup): Add setup docs and easy install script #160

Uh oh!

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!

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!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants