From c8b1c912bdd43bd2779b4a925f3e235ca35512c5 Mon Sep 17 00:00:00 2001 From: daniel muniz Date: Thu, 13 Jun 2024 09:58:53 -0300 Subject: [PATCH] implementing more descriptions --- README.md | 55 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 40 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3cbedd4..526376c 100644 --- a/README.md +++ b/README.md @@ -35,33 +35,58 @@ insserv gcf1 systemctl enable gcf1 ``` +5. Go to: /usr/local/gcf1/ and open etc/gcf1.conf with a text editor. Edit the following and save the +file. +FC_DL_PATH=/dl100/get.cgi +FC_DL_PATH_SMALLDB=/dls100/get.cgi +... +FC_PLACE={Your Company Name} +FC_LICENCE={Your SDK License Key} +FC_EMAIL={Your Email Address} + +6. To start the service, run: + +``` +sbin/gcf1 start +Starting gcf1d services: ...succeeded +``` + +7. To download/update databases, run: + +``` +bin/gcf1dbmng.sh etc urldb_download +Success DB download . +bin/gcf1dbmng.sh etc urldb_update +Success DB update . +``` + ## UDP Server Setup 1. Clone the repository: - ```bash - git clone - cd - ``` +```bash +git clone +cd +``` 2. Install the dependencies: - ```bash - npm install - ``` +```bash +npm install +``` 3. Create a .env file in the root of the project and add your environment variables. At a minimum, you should specify the PORT: - ``` - cp .env.example .env - PORT=3000 - ``` +``` +cp .env.example .env +PORT=3000 +``` ## Running the Server To start the UDP server, use the following command: - ``` - npm start - ``` - This will run the server and bind it to the port specified in your .env file. +``` +npm start +``` +This will run the server and bind it to the port specified in your .env file.