# TLDR on running the server

For a more complete guide please check the full documentation https://crivella.github.io/ocr_translate/index.html

## Files

- `run.bat`           - WINDOWS, batch file to run the server
- `run-user.bat`      - WINDOWS, utility batch file to set some environment variables and run the server
- `run.sh`            - LINUX, script to run the server
- `run-user.sh`       - LINUX, utility script to set some environment variables and run the server
- `run_server.py`     - Python script handling initial checks, some environment variables, db initialization and running the server
- `CHANGELOG.md`      - Changelog file
- `README_release.md` - This file
- `mysite/`           - Django project directory
  - `server.py`         - Server configuration file (should not need to be changed unless for advanced users)
  - `urls.py`           - URL routing file (should not need to be changed unless for advanced users)
  - `wsgi.py`           - WSGI configuration file (should not need to be changed unless for advanced users)
  - `asgi.py`           - ASGI configuration file (should not need to be changed unless for advanced users)
  - `__init__.py`       - Python package initialization file (should not need to be changed unless for advanced users)

## Running the server

- WINDOWS: Run `run-user.bat` (double-click on it)
  - Optionally, edit `run-user.bat`  with a text editor to change the environment variables.
    Some of the most common ones are already there empty.
    For a complete list of environment variables, used by the server for configuration and how to set them see
    https://crivella.github.io/ocr_translate/user/envs.html

- LINUX: Run `run-user.sh` (open a terminal, and from the directory where the script is, type `./run-user.sh`)
  - Possible problems: If you get a permission denied error, you may need to give the script execution permission.
    To do that, type `chmod +x run-user.sh` in the terminal and then try to run the script again.
  - Optionally, edit `run-user.sh` with a text editor to change the environment variables.
    Some of the most common ones are already there empty.
    For a complete list of environment variables, used by the server for configuration and how to set them see
    https://crivella.github.io/ocr_translate/user/envs.html

For other methods of running the server, see https://crivella.github.io/ocr_translate/install_run/index.html