Skip to content

Minor development environment setup doc improvements #966

@hww-nikhilshankarnoble

Description

@hww-nikhilshankarnoble

Hi CG-Wire team!

I setup a local development environment for Zou for the first time yesterday to test the events system, following the documentation at https://zou.cg-wire.com/development/

While it was very easy to setup, there were a few very small things that caught me out initially that I wanted to suggest as improvements that might make it easier for future users. I'm happy to make these changes myself in a PR but I don't believe the documentation is open-source anymore? I might just be blind, but I couldn't find it under the organisation.

  • When installing Meilisearch, it instructs you to pull v1.8.3 but then runs with v1.5 - which causes it to pull again (and the v1.8.3 image is never used). I had some small bumps setting up the indexer (listed below) and this gave me a little confusion over the version I should be using.
  • The indexer was originally not working for me when following the setup instructions, I was getting issues that the indexer wasn't initialised. I eventually stumbled across https://zou.cg-wire.com/indexer/#refreshing-indexes which led me to run the DB_PASSWORD=... INDEXER_KEY=... zou reset-search index command that fixed this for me. Not sure if I did something wrong during the setup here but might be worth a mention!
  • In order for the tests_search.py module to succeed, the INDEXER_KEY=meilimasterkey environment variable should be set for the py.test command. It would be good to note that this is required - and that ffprobe must be installed for the movie tests to pass.

Thanks!
Nikhil

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions