mirror of
https://github.com/arcan1s/ffxivbis.git
synced 2025-07-15 06:45:49 +00:00
rename service to ffxivbis, add notes about venv
This commit is contained in:
26
README.md
26
README.md
@ -9,14 +9,23 @@ This service requires python >= 3.7. For other dependencies see `setup.py`.
|
||||
In general installation process looks like:
|
||||
|
||||
```bash
|
||||
python setup.py build
|
||||
python setup.py build install
|
||||
python setup.py test # if you want to run tests
|
||||
```
|
||||
|
||||
Service can be run from `src` directory by using command:
|
||||
With virtualenv (make sure that virtualenv package was installed) the process may look like:
|
||||
|
||||
```bash
|
||||
python -m service.application.application
|
||||
virtualenv -p python3.7 env
|
||||
source env/bin/activate
|
||||
python setup.py install
|
||||
pip install aiosqlite # setup.py does not handle extras
|
||||
```
|
||||
|
||||
Service can be run by using command (if you don't use virtualenv, you have to run it from `src` directory):
|
||||
|
||||
```bash
|
||||
python -m ffxivbis.application.application
|
||||
```
|
||||
|
||||
To see all available options type `--help`.
|
||||
@ -27,6 +36,17 @@ REST API documentation is available at `http://0.0.0.0:8000/api-docs`. HTML repr
|
||||
|
||||
*Note*: host and port depend on configuration settings.
|
||||
|
||||
### Authorization
|
||||
|
||||
Default admin user is `admin:qwerty`, but it may be changed by generating new hash, e.g.:
|
||||
|
||||
```python
|
||||
from passlib.hash import md5_crypt
|
||||
md5_crypt.hash('newstrongpassword')
|
||||
```
|
||||
|
||||
and add new password to configuration.
|
||||
|
||||
## Configuration
|
||||
|
||||
* `settings` section
|
||||
|
Reference in New Issue
Block a user