Merge remote-tracking branch 'origin/justfile'

Makefile

@@ -0,0 +1,30 @@
+server_clean:
+	rm server
+
+client_clean:
+	rm client
+
+clean: server_clean client_clean
+
+server:
+	go build server.go
+
+client:
+	go build client.go
+
+build: server client
+
+ins_server:
+	go build -o ekho_server server.go
+	mv ekho_server /usr/local/bin/
+	cp ekho.service /etc/systemd/system/ekho.service
+	mkdir -p ~/.config/ekho
+	ln -s -r ./list.q ~/.config/ekho/list.q
+	systemctl daemon-reload
+	systemctl enable ekho
+	systemctl start ekho
+	systemctl status ekho
+
+ins_client:
+	go build -o ekho client.go
+	mv ekho /usr/local/bin/

README.md

@@ -3,80 +3,84 @@
 ## Why?
 To test my abilities to develop networked programs, and to enhance my skills in writing such.
 ## Requirements
+
 ### Hardware
 - Client machine
 - Server machine (not required to be distinct from Client)
+
 ### Software
-- [Golang]
+- Tested with [golang] v1.26
-- Linux distro (highly recommened)
+- Installation has only been tested with [just] v1.53
-- ```make``` is also used in this guide, but the makefile is incredibly simple, and can be skipped entirely by running ```go build``` instead
+- Server installation assumes systemd (tested with v260.2)
+
 ### Installation
-Golang can be installed on Mac with
-``` sh
-brew install golang
-```
 Clone the repo
 ``` sh
 git clone https://github.com/alexander-the-alright/ekho
 cd ekho
 ```
-Using your favorite text editor, change the destination IP and Port to whatever works for you. This is defined on line 247 in client.go as 127.0.0.1:1300.
 
-Now the server file needs to be run on the preferred port, as specified in the client file. This is defined on line 257 in server.go.
+#### Justfile
+It is recommended to use ```just``` for installation, as it has more
+capabilities than ```make```, however, there is a makefile included.
+To install the server with ```just```, run ```sudo just ins_server```.
+You will be prompted to enter a new port number to run the server on (
+or leave blank to use 1300). The port will be changed in the source
+file before compilation.
+To install the client with ```just```, run ```sudo just ins_client```.
+You will be prompted to enter the IP (or URL) and port of the server
+(or leave blank to use localhost:1300). The IP/URL and port will be
+changed in the source file before compilation.
 
+#### Makefile
+If you are unable or willing to use ```just```, the included makefile
+still has most of the functionality, but it does not change any
+important parameters. The following changes are advised before
+installation.
 
-The binary(s) can be obtained using the makefile
+1. On the client machine, change the IP/URL and port in the client source file. This can be
-If the server is being run on a separate machine, only run make with client flag
+done quickly with ```sed -i -e "s/127.0.0.1:1300/YOUR.IP.GOES.HERE:PORT/" client.go```
-``` sh
+2. On the server machine, change the port in the server source file. This can be done with a
-make client
+similar command: ```sed -i -e "s/1300/PORT/" server.go```. (note: this
-```
+should match the port from bullet 1)
-If both binaries are being run on the same machine, ```make all``` will suffice. Although, both of these commands can be bypassed with ```go build```, as this is all ```make``` does anyway.
+3. On the server machine, change the user referenced in the systemd service file. This can be
-``` sh
+done with another sed command, ```sed -e -i "s/USER/YOUR_USERNAME/" ekho.service```
-make all
-```
 
-#### NOTE
+After making these changes on the respective machines, run either
-In previous versions, the suggested method of installation involved placing bash scripts in ```/etc/update-motd.d/```, however, there have been issues getting that installation method working (namely, having MOTD run user-defined commands), and the current quick and extremely dirty suggested installation method is to just append the user's shell config files (```.bashrc```, ```.bash_profile```, ```.zshrc```, etc) with the paths to the executables.
+```sudo make ins_client``` or ```sudo make ins_server``` to compile and install the client
+and/or server binaries.
 
-For example, if the server used zsh, the installation could look something like this:
+#### After Installation
-``` sh
+After installation of the server binary, systemd will display the
-echo "~/abs/path/to/server.o &" >> ~/.zshrc
+status of the new service. It should be ```enabled``` and
-```
+```running```.
-Similarly for a client using Bash:
-``` sh
-echo "~/abs/path/to/client.o" >> ~/.bashrc
-```
-
-Any help figuring out the issue with MOTD would be appreciated.
 
 Finally done!
+
 ### Usage
 The client uses the following flags
 ``` sh
--h      - display help message
+-h               - display help message
--a <s>  - adds required argument <s> as a quote to server
+-a  <string>     - adds required argument <s> as a quote to server
--l      - list all quotes
+-ip <ip:port>    - specify alternate server destination
--r [i]  - remove; may be run with or without argument
+-l               - list all quotes
--ip     - specify alternate server destination
+-r [i]           - remove; may be run with or without argument
--s      - specify the size of the receipt buffer
+-s <i>           - specify the size of the receipt buffer
 ```
 The server uses the following flags
 ``` sh
 -h      - display help message
--s      - specify the size of the receipt buffer
+-s <i>  - specify the size of the receipt buffer
+-v      - display version and exit
+-vv     - display version and about info and exit
 ```
 
-### How It Works 
-The sequence diagram can be viewed in ```diag``` folder, which shows the sequence of networked messages for each usage of ekho.
-The source code is in the same folder, ```ekho-seq.txt```, and can be uploaded to [sequencediagram.org][seqdiag] to rerender the diagram and view any updates.
-
-
 ### To Be Implemented
 - Log all uses/transaction data each day
-- Request, send, and receive the logfile for any day
+- Request, send, and receive the logfile
 - User-specific quotes/quotefiles
-- Installation (client-side, at least) via MOTD
+- Colored printing and coloring quotes
-
+- Edit quotes
 
 [golang]: <https://go.dev/doc/install>
-[seqdiag]: <sequencediagram.org>
+[just]: <https://github.com/casey/just>

client.go

@@ -339,7 +339,7 @@ func main() {
     flag.BoolVar( &add, "a", false, "add quote to list" )
     flag.BoolVar( &remove, "r", false, "remove quote from list" )
     flag.BoolVar( &list, "l", false, "print quote list" )
-    flag.StringVar( &dest, "ip", "earth-1.net:1300", "ip:port of server" )
+    flag.StringVar( &dest, "ip", "127.0.0.1:1300", "ip:port of server" )
     flag.IntVar( &tsize, "s", 256, "transmission size ( bytes )" )
     flag.Parse()    // process flags
 

ekho.service

@@ -6,9 +6,9 @@ After=network.target
 Type=simple
 Restart=always
 RestartSec=5
-User=
+User=USER
-ExecStart=/usr/local/bin/server
+ExecStart=/usr/local/bin/ekho_server
-WorkingDirectory=/home/
+WorkingDirectory=/home/USER/.config/ekho
 
 [Install]
 WantedBy=multi-user.target

justfile

@@ -33,26 +33,37 @@ ins_server:
     if [[ $PORT -ne "" ]]; then
         sed -i -e "s/1300/$PORT/" server.go
     fi
-    echo "go build server.go"
+    echo "go build -o ekho_server server.go"
-    go build server.go
+    go build -o ekho_server server.go
+    echo "mv ekho_server /usr/local/bin/"
+    mv ekho_server /usr/local/bin/
     USER=($(users))
-    sed -i -e "s/^User=/User=${USER[0]}/" ekho.service
+    sed -i -e "s/USER/${USER[0]}/" ekho.service
-    sed -i -e "s/^WorkingDirectory=.*/WorkingDirectory=\/home\/${USER[0]}\//" ekho.service
+    echo "cp ekho.service /etc/systemd/system/"
-    echo "sudo mv server /usr/local/bin/server"
+    cp ekho.service /etc/systemd/system/
-    sudo mv server /usr/local/bin/server
+    mkdir -p ~/.config/ekho
-    echo "sudo mv ekho.service /etc/systemd/system/"
+    echo "ln -s -r ./list.q ~/.config/ekho/list.q"
-    sudo mv ekho.service /etc/systemd/system/
+    ln -s -r ./list.q ~/.config/ekho/list.q
+    echo "systemctl daemon-reload"
+    systemctl daemon-reload
+    echo "systemctl enable ekho"
+    systemctl enable ekho
+    echo "systemctl start ekho"
+    systemctl start ekho
+    echo "systemctl status ekho"
+    systemctl status ekho
+
 
 # install client
 ins_client:
     #!/usr/bin/bash
-    echo "enter ip and port of server, 'aaa.bbb.ccc.ddd:port"
+    echo "enter url or ip and port of server, 'aaa.bbb.ccc.ddd:port"
     read IP_PORT
     sed -i -e "s/:1300/$IP_PORT/" client.go
     echo "go build -o ekho client.go"
     go build -o ekho client.go
     sed -i -e "s/$IP_PORT/:1300/" client.go
-    echo "sudo mv ekho /usr/local/bin/"
+    echo "mv ekho /usr/local/bin/"
-    sudo mv ekho /usr/local/bin/
+    mv ekho /usr/local/bin/
     echo "add 'ekho' to shell config (config.fish, .bashrc, etc)"