aybDev/ayb/commands.md

1.1 KiB

Commands

Basic commands for ayb development

  • SMTP server: ./tests/smtp_server.sh 10026
    • Note: You need to create the cert.pem and key.pem files.
    • Run openssl req -nodes -new -x509 -keyout ./tests/smtp_data_10026/key.pem -out ./tests/smtp_data_10026/cert.pem.
      • The only important value is the CN, which should be set to localhost. The rest doesn't really matter, I normally use AQ and Antartica.
      • Note: You need openssl installed in your system to run the command (you need openssl-devel anyway to build ayb).
  • Run ayb server: cargo run -- server.
    • Note: You need a valid ayb.toml file.
    • Run cargo run -- default_server_config > ayb.toml.
    • Change smtp_port to 10026.
    • Change smtp_username to "username".
    • Change smtp_password to "password".
    • Set e2e_testing to true
  • Only run SQLite tests: cargo test client_server_integration_sqlite -- --exact.
    • After E2E testing the 10026 port may still be in use. The simplest way to kill the process using the port is running freeport 10026.
    • If freeport isn't installed, run pip install freeport.