kingkevin
/
partdb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: explain attachments

This commit is contained in:
King Kévin 2023-01-28 06:18:14 +01:00
parent 4e2e761489
commit 9894c27498
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,4 +1,11 @@
partdb is an electronic parts manager.
partdb is an electronic parts inventory manager.
usage
=====
Once the service is installed, there is a single page to search, add, delete, or update parts.
The only aspect not handled by the web frontend is the attachments.
Just add the files directly on the server under `public/attachments/<part_name>/`.
goals
=====
@ -59,3 +66,5 @@ mysql --user=partdb --password=password --database=partdb < schema.sql
put the database access information in `credentials.json` and run `server.rb`.
now go to http://localhost:4244 and you are ready to use it.
use a proxy web server to handle the authentication, TLS, compression, ...