some readme changes

This commit is contained in:
mst 2025-02-28 07:30:02 +03:00
parent e7e6650ecd
commit 50de61fb24
No known key found for this signature in database

View file

@ -1,17 +1,20 @@
# ![CatAsk icon](./static/icons/catask-32.png) CatAsk
a work-in-progress minimal single-user q&a software
a simple & easy to use Q&A software that makes answering questions easier
> [!NOTE]
> CatAsk is alpha software, therefore bugs are expected to happen
<!--> [!NOTE]
> CatAsk is alpha software, therefore bugs are expected to happen-->
## Prerequisites
- MySQL/MariaDB
- PostgreSQL
- Python 3.10+ (3.12+ recommended)
## Install
Clone this repository: `git clone https://git.gay/mst/catask.git`
<!--### Docker
See [docker.md](https://git.gay/mst/catask/src/branch/main/docker.md)-->
### VPS-specific
Go into the cloned repository, create a virtual environment and activate it:
@ -40,7 +43,7 @@ First, rename `.env.example` to `.env` and `config.example.json` to `config.json
`DB_NAME` - database name
`DB_USER` - database user
`DB_PASS` - database password
`DB_PORT` - database port (usually 3306)
`DB_PORT` - database port (usually 5432)
`ADMIN_PASSWORD` - password to access admin panel
`APP_SECRET` - application secret, generate one with this command: `python3 -c 'import secrets; print(secrets.token_hex())'`
@ -66,5 +69,5 @@ Runs on `127.0.0.1:8000` by default
### Caddy
This repository contains an example Caddyfile that runs CatAsk on catask.localhost by reverse proxying it to 127.0.0.1:5000, you can modify it as needed
## Updating
For instructions with updating from one version to another, check [UPDATE.md](https://git.gay/mst/catask/src/branch/main/UPDATE.md) file
Check [CHANGELOG.md](https://git.gay/mst/catask/src/branch/main/CHANGELOG.md) file for release notes
For instructions with updating from one version to another, check [UPDATE.md](./UPDATE.md) file
Check [CHANGELOG.md](./CHANGELOG.md) file for release notes