https://github.com/knowvus/duke

Server
https://github.com/knowvus/duke

backend duke

Last synced: 30 days ago
JSON representation

Server

• Host: GitHub
• URL: https://github.com/knowvus/duke
• Owner: Knowvus
• License: gpl-3.0
• Created: 2024-08-18T02:34:12.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-09-30T21:38:03.000Z (4 months ago)
• Last Synced: 2024-11-09T02:49:11.403Z (3 months ago)
• Topics: backend, duke
• Language: Rust
• Homepage:
• Size: 6.47 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# SUMMARY

Duke is a middleware microservice Server that facilitates communication between:

- Frontend: Raynor [Website]

- Backend: Kerrigan [Postgres]

# GOAL

1) Refactor to Actions Github repo

2) Kerrigan Deployment

3) Duke Communicate with Kerrigan

4) Raynor Deployment

# Table of Contents

- [LOCAL TESTING](#local-testing)

- [NEXT STEP](#next-step)

- [DIRECTORY STRUCTURE](#directory-structure)

- [OPERATIONS](#operations)

# STATUS

[![Build and Deploy Docker Image](https://github.com/Knowvus/Duke_rs/actions/workflows/deploy.yml/badge.svg)](https://github.com/Knowvus/Duke_rs/actions/workflows/deploy.yml)

# MILESTONES

[] Create_User Integrate with Postgres

   [] Error Message for Duplicate Email

[] Create_Task Integrate with Postgres

   [] Non Null String

these endpoints should be callable via CLI [this is how we can test since it's a microservice]

Call the endpoint on the server - server servces the DB, DB responses, server serves DB response

# LOCAL TESTING

    ```

    Build Time: ~4 Mins

    ```

1) **Run the Server Locally:**

    ```

    cargo clean

    cargo build

    cargo run

    ```

2) **Test the YAML Locally**

    ```

    act -j deploy --container-architecture linux/amd64

    ```

2) **Endpints:**

    ```

    - curl http://localhost:8080/create_user -d "[email protected]"

    - curl http://localhost:8080/create_task -d "Reverse this String!"

    - curl -f http://localhost:8080/health

    ```

4

5) **CLI**

    ### Docker

     ```

    docker ps -a

    docker ps

    docker inspect [service_name]

    docker logs [service_name]

    docker rm [container_id]

    docker exec -it duke ping kerrigan

    ```

    ### Docker Swarm

    ```

    docker swarm join --token  >:

    docker swarm init --advertise-addr 

    ```

    ### GENERAL

    ```

    ls

    ls -a

    sudo lsof -i :8080

    ```

    ### UPDATE PORT

    ```

    sudo nano /etc/ssh/sshd_config

    uncommment #Port=22

    sudo mkdir -p /run/sshd

    sudo chmod 0755 /run/sshd

    sudo systemctl restart ssh

    sudo systemctl status ssh

    ```

    ### BASIC FIREWALL

    INSTALL

    ```

    sudo apt update

    sudo apt install fail2ban

    sudo systemctl enable fail2ban

    sudo systemctl start fail2ban

    ```

    UPDATE CONFIG: add to /etc/ssh/sshd_config

    ```

    Match Address 218.92.0.81

        PermitRootLogin yes

    ```

    RUN CMD

    ```

    sudo systemctl restart ssh

    ```

    UPDATE CONFIG: add to /etc/fail2ban/jail.local on droplet:

    ```

    sudo ufw status

    sudo ufw allow ssh

    sudo ss -tuln | grep :22

    [sshd]

    enabled = true

    ignoreip = 127.0.0.1/8 218.92.0.81

    [sshd]

    enabled = true

    port = ssh

    logpath = %(sshd_log)s

    maxretry = 5

    bantime = 10m

    findtime = 10m

    ```

    RUN: CMD

    ```

    sudo systemctl restart fail2ban

    sudo fail2ban-client status sshd

    ```

---

# COMING SOON

1) **API Documentation**

    ```

    OpenAPI JSON: http://:8080/api-doc/openapi.json

    Swagger UI: http://:8080/docs

    - curl -f http://localhost:8080/docs

 

    ```