mirror of
https://codeberg.org/catask-org/catask.git
synced 2025-04-20 13:53:42 -05:00
55 lines
2 KiB
Markdown
55 lines
2 KiB
Markdown
# CatAsk
|
|
|
|
a work-in-progress minimal single-user q&a software
|
|
|
|
## Install
|
|
Clone this repository: `git clone https://git.gay/mst/catask.git`
|
|
|
|
### VPS-specific
|
|
Go into the cloned repository, create a virtual environment and activate it:
|
|
|
|
#### Linux
|
|
```python -m venv venv && . venv/bin/activate```
|
|
|
|
#### Windows (PowerShell)
|
|
```python -m venv venv; .\venv\Scripts\activate```
|
|
|
|
---
|
|
|
|
After that, install required packages:
|
|
```pip install -r requirements.txt```
|
|
|
|
### Shared hosting-specific
|
|
If your shared hosting provider supports [WSGI](https://w.wiki/_vTN2), [FastCGI](https://w.wiki/9EeQ), or something similar, use it (technically any CGI protocol could work)
|
|
|
|
## Post-install
|
|
|
|
## Configuration
|
|
|
|
First, rename `.env.example` to `.env` and `config.example.py` to `config.py`, then configure all the values below:
|
|
|
|
### .env
|
|
`DB_HOST` - database host (usually 127.0.0.1)
|
|
`DB_NAME` - database name
|
|
`DB_USER` - database user
|
|
`DB_PASS` - database password
|
|
`ADMIN_PASSWORD` - password to access admin panel
|
|
`APP_SECRET` - application secret, generate one with this command: `python -c 'import secrets; print(secrets.token_hex())'`
|
|
|
|
### config.py
|
|
`instanceTitle` - title of CatAsk instance
|
|
`instanceDesc` - description of CatAsk instance
|
|
`fullBaseUrl` - full base URL to CatAsk instance, e.g. `https://ask.example.com`
|
|
|
|
---
|
|
|
|
After you're done configuring CatAsk, init the database: `flask init-db`
|
|
If that doesn't work (e.g. tables are missing), try importing schema.sql into the created database manually
|
|
|
|
## Usage
|
|
|
|
Use one of these commands to run CatAsk: `flask run` or `gunicorn -w 4 app:app` (if you have gunicorn installed) or `python app.py`
|
|
If you want CatAsk to be accessible on a specific host address, specify a `--host` option to `flask run` (e.g. `--host 0.0.0.0`)
|
|
|
|
Admin login page is located at `https://<your domain>/admin/login/`
|
|
Runs on `127.0.0.1:5000` (`flask run` or `python app.py`) or `127.0.0.1:8000` (`gunicorn -w 4 app:app`), may work in a production environment
|