Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ryhkml committed Dec 10, 2024
1 parent d73baf0 commit 815a2b5
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,20 @@ FineTuneForge is a tool designed specifically for generating JSON Lines (JSONL)

## Getting Started

> [!WARNING]
>
> DO NOT USE IN PRODUCTION
>
> This project has no CSRF protection. I'm unsure if i will implement it. For example, i created a new CSRF protection in Angular SSR 18. See it [here](https://github.com/ryhkml/angular-double-csrf-protection)
To get started with FineTuneForge, follow these steps:

### Installation

```sh
git clone https://github.com/ryhkml/fine-tune-forge.git
cd fine-tune-forge
chmod +x ./install.sh
./install.sh
sh install.sh
```

### Usage
Expand All @@ -39,10 +44,10 @@ npm run serve

FineTuneForge is organized into several directories, each serving a specific purpose in the workflow of the JSONL generator. Below is an overview of these directories and their intended use:

- `DATADOC_OCR`: This directory acts as a temporary storage for OCR (Optical Character Recognition) images
- `DATASET`: The `DATASET` directory is the designated location for storing the completed dataset files. Once the JSONL files have been generated and are ready for use in fine-tuning the language models, they are placed in this directory
- `DATATMP`: This directory for temporary storage of instruction content
- `tls`: This directory is reserved for storing SSL/TLS certificates
- `DATADOC_OCR`: This directory acts as a temporary storage for OCR (Optical Character Recognition) images
- `DATASET`: The `DATASET` directory is the designated location for storing the completed dataset files. Once the JSONL files have been generated and are ready for use in fine-tuning the language models, they are placed in this directory
- `DATATMP`: This directory for temporary storage of instruction content
- `tls`: This directory is reserved for storing SSL/TLS certificates

## Configuring SSL/TLS for HTTPS

Expand All @@ -52,12 +57,12 @@ To enable HTTPS in the application, you need to configure SSL/TLS certificates c

Before you start, ensure you have the following files placed in the `tls` directory:

- `fullchain.pem`: This is your certificate file that contains the full chain of trust, including any intermediate certificates along with your own
- `cert-key.pem`: This file contains your private key and must be kept secure. It is used to establish the encrypted connection
- `ca.crt` (optional): This Certificate Authority (CA) file is used if you need to specify an external CA
- `fullchain.pem`: This is your certificate file that contains the full chain of trust, including any intermediate certificates along with your own
- `cert-key.pem`: This file contains your private key and must be kept secure. It is used to establish the encrypted connection
- `ca.crt` (optional): This Certificate Authority (CA) file is used if you need to specify an external CA

If you use docker, uncomment the environment variable `PROTOCOL_SERVER` in `docker-compose.yaml`

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

0 comments on commit 815a2b5

Please sign in to comment.