search

OllisGit / OctoPrint-FilamentManager

OctoPrint plugin to manage your filament inventory
GNU Affero General Public License v3.0
53 stars 24 forks source link

Better documentation #78

Open SaKiEQ opened 3 years ago

SaKiEQ commented 3 years ago

I tried for several hours to do a 'quick' installation of the plugin and its external PostgreSql Database.

Now I am neither new to linux, nor new to client / server situations. But I could for the longest time not make it work. While installing it as a single client is straight forwards, client server I find at best confusing and frustrating.

I would suggest you make a separate guide for PostgreSql/Filament Manager client (Octoprint side) and server PostgreSql Database side. In my technical understanding, installing PostgreSql with setting up the database and user makes sense on which ever machine, hence in a server / client situation this would mean for my logic, that this has to happen only on the 'server' machine (different the client that runs Filament Manager).

In my understanding of a client, it would require only the psycopg2 install, since the database is external. But here things seem to be wrong in my logic (and I think others too), even the client requires the install of PostgreSql, just without database for the connection to work.

Having finally installed both, just locally without setting up a database, I got it to work.

Also some small hints for beginners how to exit the PostgreSql CLI (Exit) would help many that are less used to work deeper under the hood. The install paths are out of date, they reference 9.6 version, where today 11 is automatically installed, making the paths dysfunctional... (/etc/postgresql/9.6/main/).

I would assume that most non developer do not work with a virtualenv to begin with, since they are based on a ready to use OctoPrint image, hence that reference / instructions can be more then confusing.

Maybe I am too tired and not focused enough... but thankfully I got it to work never the less.

OllisGit commented 3 years ago

Hi @SaKiEQ,

thanks for your feedback, always welcome.

Btw. did you read the FM-Wiki? https://github.com/OllisGit/OctoPrint-FilamentManager/wiki image

If you think the documentation is wrong or important parts were missing, feel free to write a new or improve the documentation. I will include your documentation in the Wiki, so that other users could handle the setup more easily.

BR Olli