Mirrors/polaris
2
0
Fork 0
mirror of https://github.com/agersant/polaris synced 2024-11-10 02:04:13 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated list of useful options

Browse source
This commit is contained in:
Antoine Gersant 2020-01-20 18:31:02 -08:00
parent 27d0a9e158
commit 0c28f54f01
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -9,10 +9,12 @@ Compiling and running Polaris is very easy as it only depends on the Rust toolch
Polaris supports a few command line arguments which are useful during development:
- `-w some/path/to/web/dir` lets you point to the directory to be served as the web interface. You'll probably want to point this to the `/web` directory of the polaris repository.
- `-d some/path/to/a/file.db` lets you manually choose where Polaris stores its configuration and music index (you can reuse the same database accross multiple runs)
- `-f` (on Linux) makes Polaris not fork into a separate process
- `-s some/path/to/web/dir` lets you point to the directory to be served as the swagger API documentation. You'll probably want to point this to the `/docs/swagger` directory of the polaris repository.
- `-d some/path/to/a/file.db` lets you manually choose where Polaris stores its configuration and music index (you can reuse the same database accross multiple runs).
- `-c some/config.toml` lets you use a configuration file to add content to the database. This can be useful if you frequently delete the database and would like to automate the first time flow. The configuration format is not documented but can be inferred by looking at the `Config` struct in `config.rs`.
- `-f` (on Linux) makes Polaris not fork into a separate process.
Putting it all together, a typical command to compile and run the program would be: `cargo run -- -w web -d test/my.db`
Putting it all together, a typical command to compile and run the program would be: `cargo run -- -w web -s docs/swagger -d test/my.db`
While Polaris is running, access the web UI at [http://localhost:5050](http://localhost:5050).