chatgpt_assistant 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9317ab1f4742c358a91f3e8ec363d8ed72147c2a31e0a312ec6c5ad54215c8db
-  data.tar.gz: e3a6a3f6099a4dcb47b262fb388f5f783a2f48466b1946f2e140e1a1b4c25767
+  metadata.gz: cb819ab0257d4970e716aed3d6d59cb5ef89d0476525b5c7dbd93f03df97b309
+  data.tar.gz: 9ce437ae8051fab6fbfd0b446fdaecd60f17dad068d55d96d572877c915b217f
 SHA512:
-  metadata.gz: 3ea5f6b13b7db43f7261d9a726257bdf9e37a45bda2d34149bf7c35c659eee8092aec29a3dc7db8dc3222c005c65941f10f6b24f589f20ab0786a91e69290f27
-  data.tar.gz: 46e7e83be3e53a7ece0fbaf0c59d67054270e05e0d6fad8b4fb09194f57a2de82d136203110fb9de20d11a1160c8b29dd2be19a026567528c898224a08452f67
+  metadata.gz: aac472695d96b1566294928d09a80b4d49f995519da1df049f85aa8a51baff1585e35f8669f2842755423303f4a1b27eb740a7ca9c00691978e47254edbd5494
+  data.tar.gz: fd8075eb05fe5e354676311884ba55f26ae5a073536076a4d40914e34a66c4e45e7f98e9d85967d9a36828362f4cf9076d2e74af2c99359fddbf39fd907218db

data/.env_sample

@@ -1,18 +1,43 @@
+# Bot Settings
 ENV_TYPE=development
-LANGUAGE=en # or pt currently
-MODE=aws # or ibm
+LANGUAGE=en
+MODE=aws
 DISCORD_PREFIX=!!
+LUCY_SU= Your command to run docker compose as root
 
-POSTGRES_DB=chatgpt_assistant_development # or your database
-POSTGRES_USER=postgres # or your user
-POSTGRES_PASSWORD=postgres # or your password
+# Database Settings
+POSTGRES_DB=chatgpt_assistant_development
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
 
-IBM_API_KEY=Your IBM API Key
-IBM_URL=Your IBM Text to Speech URL
+# Server Settings
+REDIS_URL=redis://localhost:6379
+
+# Bot Settings
 TELEGRAM_TOKEN=Your Telegram Bot Token
+DISCORD_CLIENT_ID=Your Discord Client ID
+DISCORD_TOKEN=Your Discord Token
+
+# OpenAI Settings
 OPENAI_API_KEY=Your OpenAI API Key
-AWS_ACCESS_KEY=Your AWS Access Key
+
+# API Settings - Set MODE to the API you want to use for text to speech
+IBM_API_KEY=Your IBM API Key # set MODE=ibm
+IBM_URL=Your IBM Text to Speech URL
+
+AWS_ACCESS_KEY=Your AWS Access Key ID # set MODE=aws
 AWS_SECRET_ACCESS_KEY=Your AWS Secret Access Key
 AWS_REGION=Your AWS Region
-DISCORD_CLIENT_ID=Your Discord Client ID
-DISCORD_TOKEN=Your Discord Token
+
+AZURE_SPEECH_URL= YOUR_AZURE_SPEECH_URL # set MODE=azure
+AZURE_SPEECH_KEY= YOUR_AZURE_SPEECH_KEY
+
+# SMTP Settings
+SMTP_ADDRESS=YOUR_SMTP_ADDRESS
+SMTP_PASSWORD=YOUR_SMTP_PASSWORD
+SMTP_PORT=YOUR_SMTP_PORT
+SMTP_USER_NAME=YOUR_SMTP_USER_NAME
+SMTP_DOMAIN=YOUR_SMTP_DOMAIN
+SMTP_AUTHENTICATION=plain
+SMTP_ENABLE_STARTTLS_AUTO=true
+

data/.rubocop.yml

@@ -1,6 +1,8 @@
 AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
+  Exclude:
+    - 'Gemfile.lock'
 
 Style/StringLiterals:
   Enabled: true
@@ -26,13 +28,22 @@ Metrics/ClassLength:
   Max: 300
 
 Metrics/AbcSize:
-  Max: 35
+  Max: 62
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Style/Documentation:
+  Enabled: false
 
 Layout/AccessModifierIndentation:
   EnforcedStyle: indent
-  
+
 Layout/IndentationWidth:
   Width: 2
 
 Layout/IndentationConsistency:
-  EnforcedStyle: indented_internal_methods
+  EnforcedStyle: indented_internal_methods

data/Dockerfile

@@ -1,12 +1,18 @@
 FROM ruby:3.2.2
 RUN apt-get update -qq && apt-get install -y nodejs postgresql-client ffmpeg
-WORKDIR /chatgpt_assistant
-COPY Gemfile /chatgpt_assistant/Gemfile
-COPY Gemfile.lock /chatgpt_assistant/Gemfile.lock
+WORKDIR /assistant
+COPY Gemfile /assistant/Gemfile
+COPY Gemfile.lock /assistant/Gemfile.lock
 RUN bundle install
 
-RUN apt-get install -y wget
+RUN apt-get install -y wget libopus0 opus-tools
 RUN wget https://archive.mozilla.org/pub/opus/opus-1.3.1.tar.gz
 RUN tar -xvf opus-1.3.1.tar.gz
 RUN cd opus-1.3.1 && ./configure && make && make install
-RUN rm -rf opus-1.3.1.tar.gz opus-1.3.1
+RUN rm -rf opus-1.3.1.tar.gz opus-1.3.1
+
+RUN wget https://download.libsodium.org/libsodium/releases/libsodium-1.0.18.tar.gz
+RUN tar -xvf libsodium-1.0.18.tar.gz
+RUN cd libsodium-1.0.18 && ./configure && make && make install
+RUN ldconfig
+RUN rm -rf libsodium-1.0.18.tar.gz libsodium-1.0.18

data/Gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "bcrypt"
+gem "bcrypt", "~> 3.1"
 
 gem "rake", "~> 13.0"
 
@@ -10,54 +10,56 @@ gem "rspec", "~> 3.12", group: :test
 
 gem "rspec-rails", "~> 6.0", group: :test
 
-gem "simplecov", "~> 0.21", group: :test
+gem "simplecov", "~> 0.22", group: :test
 
-gem "vcr", "~> 6.0", group: :test
+gem "vcr", "~> 6.1", group: :test
 
 gem "shoulda-matchers", "~> 5.3", group: :test
 
-gem "factory_bot_rails", "~> 6.0", group: :test
+gem "factory_bot_rails", "~> 6.2", group: :test
 
-gem "faker", "~> 2.0", group: :test
+gem "faker", "~> 2.23", group: :test
 
 gem "database_cleaner", "~> 2.0", group: :test
 
-gem "dotenv", "~> 2.0", group: :test
+gem "dotenv", "~> 2.8", group: :test
 
 gem "rubocop", "~> 1.50"
 
-gem "rubocop-rspec", "~> 2.20"
+gem "rubocop-rspec", "~> 2.22"
 
-gem "telegram-bot-ruby", "~> 0.16"
+gem "telegram-bot-ruby", "~> 1.0"
 
 gem "discordrb", "~> 3.4"
 
-gem "faraday"
+gem "faraday", "~> 2.7"
 
-gem "activemodel"
+gem "activemodel", "~> 6.1"
 
-gem "activerecord"
+gem "activerecord", "~> 6.1"
 
-gem "activesupport"
+gem "activesupport", "~> 6.1"
 
-gem "redis"
+gem "actionmailer", "~> 6.1"
 
-gem "sidekiq"
+gem "redis", "~> 5.0"
 
-gem "sidekiq-scheduler"
+gem "sidekiq", "~> 7.0"
 
-gem "activerecord-import"
+gem "sidekiq-scheduler", "~> 5.0"
 
-gem "pg"
+gem "activerecord-import", "~> 1.4"
 
-gem "streamio-ffmpeg"
+gem "pg", "~> 1.5"
 
-gem "lucy_dockerunner"
+gem "streamio-ffmpeg", "~> 3.0"
 
-gem "ibm_watson"
+gem "lucy_dockerunner", "~> 0.2"
 
-gem "aws-sdk-polly"
+gem "ibm_watson", "~> 2.2"
 
-gem "awesome_chatgpt_actors"
+gem "aws-sdk-polly", "~> 1.72"
 
-gem "sidekiq-expiring-jobs"
+gem "awesome_chatgpt_actors", "~> 0.1"
+
+gem "sidekiq-expiring-jobs", "~> 0.1"

data/Gemfile.lock

@@ -1,56 +1,61 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.0.4.3)
-      actionview (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      rack (~> 2.0, >= 2.2.0)
+    actionmailer (6.1.7.3)
+      actionpack (= 6.1.7.3)
+      actionview (= 6.1.7.3)
+      activejob (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.7.3)
+      actionview (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.4.3)
-      activesupport (= 7.0.4.3)
+    actionview (6.1.7.3)
+      activesupport (= 6.1.7.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activerecord (7.0.4.3)
-      activemodel (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
+    activejob (6.1.7.3)
+      activesupport (= 6.1.7.3)
+      globalid (>= 0.3.6)
+    activemodel (6.1.7.3)
+      activesupport (= 6.1.7.3)
+    activerecord (6.1.7.3)
+      activemodel (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
     activerecord-import (1.4.1)
       activerecord (>= 4.2)
-    activesupport (7.0.4.3)
+    activesupport (6.1.7.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     awesome_chatgpt_actors (0.1.3)
       csv (~> 3.1)
     aws-eventstream (1.2.0)
-    aws-partitions (1.748.0)
-    aws-sdk-core (3.171.0)
+    aws-partitions (1.785.0)
+    aws-sdk-core (3.178.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.651.0)
       aws-sigv4 (~> 1.5)
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-polly (1.66.0)
-      aws-sdk-core (~> 3, >= 3.165.0)
+    aws-sdk-polly (1.72.0)
+      aws-sdk-core (~> 3, >= 3.177.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.5.2)
+    aws-sigv4 (1.6.0)
       aws-eventstream (~> 1, >= 1.0.2)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    bcrypt (3.1.18)
+    bcrypt (3.1.19)
     builder (3.2.4)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
     concurrent-ruby (1.2.2)
     connection_pool (2.4.0)
     crass (1.0.6)
@@ -61,8 +66,7 @@ GEM
       activerecord (>= 5.a)
       database_cleaner-core (~> 2.0.0)
     database_cleaner-core (2.0.1)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
+    date (3.3.3)
     diff-lcs (1.5.0)
     discordrb (3.4.0)
       discordrb-webhooks (~> 3.3.0)
@@ -76,7 +80,25 @@ GEM
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.8.1)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
     dry-inflector (1.0.0)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-struct (1.6.0)
+      dry-core (~> 1.0, < 2)
+      dry-types (>= 1.7, < 2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
     erubi (1.12.0)
     et-orbi (1.2.7)
       tzinfo
@@ -89,7 +111,7 @@ GEM
       railties (>= 5.0.0)
     faker (2.23.0)
       i18n (>= 1.8.11, < 2)
-    faraday (2.7.4)
+    faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-multipart (1.0.4)
@@ -105,6 +127,8 @@ GEM
     fugit (1.8.1)
       et-orbi (~> 1, >= 1.2.7)
       raabro (~> 1.4)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
     http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
@@ -116,7 +140,7 @@ GEM
     http-form_data (2.3.0)
     http-parser (1.2.3)
       ffi-compiler (>= 1.0, < 2.0)
-    i18n (1.12.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     ibm_cloud_sdk_core (1.1.3)
       concurrent-ruby (~> 1.0)
@@ -133,34 +157,49 @@ GEM
     jmespath (1.6.2)
     json (2.6.3)
     jwt (2.2.3)
-    loofah (2.20.0)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    lucy_dockerunner (0.1.9)
+      nokogiri (>= 1.12.0)
+    lucy_dockerunner (0.2.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
     method_source (1.0.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2023.0218.1)
-    mini_portile2 (2.8.1)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.2)
     minitest (5.18.0)
     multi_json (1.15.0)
     multipart-post (2.3.0)
+    net-imap (0.3.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
     netrc (0.11.0)
-    nokogiri (1.14.3)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.15.2)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.14.3-x86_64-linux)
+    nokogiri (1.15.2-x86_64-linux)
       racc (~> 1.4)
     opus-ruby (1.0.1)
       ffi
     parallel (1.23.0)
-    parser (3.2.2.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
-    pg (1.4.6)
+    pg (1.5.3)
     public_suffix (5.0.1)
     raabro (1.4.0)
     racc (1.6.2)
-    rack (2.2.6.4)
+    rack (2.2.7)
     rack-test (2.1.0)
       rack (>= 1.3)
     rails-dom-testing (2.0.3)
@@ -168,13 +207,12 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.5.0)
       loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
+    railties (6.1.7.3)
+      actionpack (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
-      zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
     redis (5.0.6)
@@ -192,22 +230,22 @@ GEM
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-rails (6.0.1)
+    rspec-rails (6.0.3)
       actionpack (>= 6.1)
       activesupport (>= 6.1)
       railties (>= 6.1)
-      rspec-core (~> 3.11)
-      rspec-expectations (~> 3.11)
-      rspec-mocks (~> 3.11)
-      rspec-support (~> 3.11)
+      rspec-core (~> 3.12)
+      rspec-expectations (~> 3.12)
+      rspec-mocks (~> 3.12)
+      rspec-support (~> 3.12)
     rspec-support (3.12.0)
     rubocop (1.50.2)
       json (~> 2.3)
@@ -219,13 +257,16 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
+    rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
-    rubocop-rspec (2.20.0)
+    rubocop-factory_bot (2.22.0)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.22.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     rufus-scheduler (3.8.2)
@@ -251,14 +292,14 @@ GEM
     simplecov_json_formatter (0.1.4)
     streamio-ffmpeg (3.0.2)
       multi_json (~> 1.8)
-    telegram-bot-ruby (0.23.0)
-      dry-inflector
+    telegram-bot-ruby (1.0.0)
+      dry-struct (~> 1.6)
       faraday (~> 2.0)
       faraday-multipart (~> 1.0)
-      virtus (~> 2.0)
-    thor (1.2.1)
-    thread_safe (0.3.6)
+      zeitwerk (~> 2.6)
+    thor (1.2.2)
     tilt (2.1.0)
+    timeout (0.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
@@ -266,10 +307,6 @@ GEM
     unf_ext (0.0.8.2)
     unicode-display_width (2.4.2)
     vcr (6.1.0)
-    virtus (2.0.0)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
     websocket (1.2.9)
     websocket-client-simple (0.6.1)
       event_emitter
@@ -277,43 +314,44 @@ GEM
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   ruby
   x86_64-linux
 
 DEPENDENCIES
-  activemodel
-  activerecord
-  activerecord-import
-  activesupport
-  awesome_chatgpt_actors
-  aws-sdk-polly
-  bcrypt
+  actionmailer (~> 6.1)
+  activemodel (~> 6.1)
+  activerecord (~> 6.1)
+  activerecord-import (~> 1.4)
+  activesupport (~> 6.1)
+  awesome_chatgpt_actors (~> 0.1)
+  aws-sdk-polly (~> 1.72)
+  bcrypt (~> 3.1)
   database_cleaner (~> 2.0)
   discordrb (~> 3.4)
-  dotenv (~> 2.0)
-  factory_bot_rails (~> 6.0)
-  faker (~> 2.0)
-  faraday
-  ibm_watson
-  lucy_dockerunner
-  pg
+  dotenv (~> 2.8)
+  factory_bot_rails (~> 6.2)
+  faker (~> 2.23)
+  faraday (~> 2.7)
+  ibm_watson (~> 2.2)
+  lucy_dockerunner (~> 0.2)
+  pg (~> 1.5)
   rake (~> 13.0)
-  redis
+  redis (~> 5.0)
   rspec (~> 3.12)
   rspec-rails (~> 6.0)
   rubocop (~> 1.50)
-  rubocop-rspec (~> 2.20)
+  rubocop-rspec (~> 2.22)
   shoulda-matchers (~> 5.3)
-  sidekiq
-  sidekiq-expiring-jobs
-  sidekiq-scheduler
-  simplecov (~> 0.21)
-  streamio-ffmpeg
-  telegram-bot-ruby (~> 0.16)
-  vcr (~> 6.0)
+  sidekiq (~> 7.0)
+  sidekiq-expiring-jobs (~> 0.1)
+  sidekiq-scheduler (~> 5.0)
+  simplecov (~> 0.22)
+  streamio-ffmpeg (~> 3.0)
+  telegram-bot-ruby (~> 1.0)
+  vcr (~> 6.1)
 
 BUNDLED WITH
    2.4.10

data/README.md

@@ -4,16 +4,23 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Ruby Version](https://img.shields.io/badge/Ruby-2.6.0%2B-blue.svg)](https://www.ruby-lang.org/en/)
 
-This Ruby gem provides an easy way to initialize a client for Telegram and Discord bots using the ChatGPT API, audio transcription, IBM Cloud Text to Speech, and AWS Polly, creating an assistant that can answer questions in text and voice and have a conversation with the user.
+This Ruby gem provides an easy way to initialize a client for Telegram and Discord bots using the ChatGPT API, audio transcription, Text to Speech, creating an assistant that can answer questions in text and voice and have a conversation with the user.
+
+#### Voice messages on telegram only - discord voice bot is not available and not planned to be implemented anymore
+##### Discord voice bot is been replaced by a voice assistant local packege to act like google assistant, alexa, siri, cortana, etc. The voice assistant is been developed to linux and android, but it can be ported to other platforms in the future.
+
+#### Speech to Text services - OpenAI Audio Transcription
+##### More services will be added in the future
+#### Text to Speech services - IBM Watson, AWS Polly, Azure Text to Speech
 
 #### Languages supported currently: en, pt
 
-Other contributions are welcome too!
-Remember to give a star to this repo if you like it!
+#### Registration and Account Confirmation are avaiable on telegram only, sign in with the same credentials on discord after registering on telegram.
+
 ## Requirements
 
 - Ruby > 2.6.0 - for the gem who can create bots projects in your machine
-- Ruby 3.2.2 - inside the docker contianer or for run the bots in your machine
+- Ruby 3.2.2 - inside the docker container or run the bots in your machine
 - Docker
 - Docker Compose
 - PostgreSQL
@@ -55,7 +62,7 @@ Make sure to run bundle before using the Lucy Dockerunner rake tasks.
 
 Then, edit the .env_sample file to include the necessary credentials and rename it to .env. Run bundle install to install the necessary dependencies.
 
-Remember to edit docker-compose.prod.yml when deploying to production.
+Include `LUCY_SU=sudo` in your .env if u run docker compose with sudo
 
 ## Migrate your database
 ```bash
@@ -93,14 +100,13 @@ After starting the Docker Compose services, you can use the features of the gem
 The discord commands prefix can be changed in the .env file.
 The default prefix is !!
 
-- dgpt!start - shows the welcome message
-- dgpt!help - shows the help message
-- dgpt!login email:password - logs in the user. Remember to use private messages to register or login and share a server with right permissions with the bot to message it.
-- dgpt!register email:password - registers a new user, email is not verfied yet, so you can use any email, the password is encrypted with bcrypt and stored in the database with salt.
-- dgpt!list - lists the user created chatbots
-- dgpt!sl_chat CHAT TITLE - starts a chat with the chatbot with the given title
-- dgpt!new_chat CHAT TITLE - creates a new chatbot with the given title
-- dgpt!ask TEXT - sends a text to the chatbot
+- !!start - shows the welcome message
+- !!help - shows the help message
+- !!login email:password - logs in the user. Remember to use private messages to register or login and share a server with right permissions with the bot to message it.
+- !!list - lists the user created chatbots
+- !!sl_chat CHAT TITLE - starts a chat with the chatbot with the given title
+- !!new_chat CHAT TITLE - creates a new chatbot with the given title
+- !!ask TEXT - sends a text to the chatbot
 
 ## Telegram Bot Commands
 
@@ -108,19 +114,13 @@ The default prefix is !!
 - /help - shows the help message
 - login/email:password - logs in the user. Remember to use private messages to register or login.
 - register/email:password - registers a new user, email is not verfied yet, so you can use any email, the password is encrypted with bcrypt and stored in the database with salt. Remember to use private messages to register or login.
+- confirm/* name:token - confirms the user account. Remember to use private messages to register or login
 - list - lists the user created chatbots
 - sl_chat/CHAT TITLE - starts a chat with the chatbot with the given title
 - new_chat/CHAT TITLE - creates a new chatbot with the given title
 - TEXT - sends a text to the chatbot
 - VOICE_MESSAGE or AUDIO FILE - sends a voice message to the chatbot and returns the response in voice
 
-## Recommended Actions runner
-
-You can run Github Actions workflows locally using [act](https://github.com/nektos/act)
-
-We recommend Act installation to run Github Actions workflows locally
-as we use it to deploy the bot in a server via ssh.
-
 ## Contributing
 
 A good way to contribute is add your language to DefaultMessages class in lib/chatgpt_assistant/default_messages.rb. You can also add your language to the list of languages in the README.md file.
@@ -139,7 +139,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/JesusG
 [![Activity map](https://images.repography.com/33522702/JesusGautamah/chatgpt_assistant/recent-activity/y6ZDduNWHwPzbnUFsmdGrJ99Q1vyEKGOBWFOBvzGjnM/1rZM2QrF0__3eUfUXFe6jDraYjHvypniTqDWhCequ-U_map.svg)](https://github.com/JesusGautamah/chatgpt_assistant/commits)
 
 ## Contributors
-  - [Jesus Gautamah](https://github.com/JesusGautamah) 
+  - [Jesus Gautamah](https://github.com/JesusGautamah)
 
 ## License
 
@@ -147,4 +147,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the ChatgptAssistant project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JesusGautamah/chatgpt_assistant/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ChatgptAssistant project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JesusGautamah/chatgpt_assistant/blob/master/CODE_OF_CONDUCT.md).