clearing up some installation instructions (#164)

* clearing up some installation instructions

Author: akpdw

README.md

@@ -43,7 +43,7 @@ manage virtual environments. These docs assume `venv`.
 	- Unix, Windows, and MacOS [installation and use guide for venv](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/).
 	- Your operating system might have some prerequisites here. On ubuntu, you may need:
 		```sh
-		sudo apt-install python3-pip python3.12-venv
+		sudo apt install python3-pip python3.12-venv
 		```
 1. Set up the virtual environment and run it. Run these commands in the
 directory where you've cloned the repository. (Adapt as needed for your shell
@@ -79,8 +79,6 @@ When you're done with the virtual environment, you can type `deactivate` to leav
 		python -m build && \
 		pip install dist/*.whl
 		``` 
-    -NOTE: In the current development stage of the project, we may exhibit code changes without change of the version number. In case you update your local code, this build process has to be repeated, but with the last command modified to ```pip install dist/*.whl --force-reinstall```
-    - In the file ```soundcork/gunicorn_conf.py```, replace the binding address 127.0.0.1 by the IP address of your server
     - If using systemd, make a copy of `soundcork.service.example`, named `soundcork.service`
 	- modify the placeholder strings appropriately
 	- then mv to systemd and enable.
@@ -90,6 +88,14 @@ When you're done with the virtual environment, you can type `deactivate` to leav
 		sudo systemctl enable soundcork && \
 		sudo systemctl start soundcork
 		```
+    - To update the server, rebuild the project and restart. NOTE: In the current development stage of the project, we code changes may happen without a change of the version number. In these cases, or if you update your local code yourself, this build process has to be repeated, but with the last command modified to ```pip install dist/*.whl --force-reinstall```:
+      ```
+      git pull
+      pip install build && \
+      python -m build && \
+      pip install dist/*.whl --force-reinstall
+      sudo systemctl restart soundcork
+      ```
 
 You can verify the server by checking the `/docs` endpoint at your URL.
 

soundcork.service.example

@@ -7,13 +7,20 @@ After=network.target
 
 [Service]
 
-User=YOUR_USER_NAME_HERE
+PIDFile=/run/soundcork.pid
 
-Group=YOUR_GROUP_NAME_HERE
+# user soundcork should run as
+User=${USER}
 
-WorkingDirectory=YOUR_DIRECTORY_NAME_HERE
+# ${INSTALL_DIR} should be the root of your git checkout, so the resulting
+# WorkingDirectory will probably be something like .../soundcork/soundcork
+WorkingDirectory=${INSTALL_DIR}/soundcork
 
-ExecStart=YOUR_DIRECTORY_NAME_HERE/.venv/bin/gunicorn -c gunicorn_conf.py main:app
+# ditto on ${INSTALL_DIR}, though this time the resulting file should be
+# more like .../soundcork/.venv/bin/gunicorn
+# replace 0.0.0.0:8000 with 127.0.0.1:8000 if you are running behind
+# a webserver like nginx and don't want direct access from the outside
+ExecStart=${INSTALL_DIR}/.venv/bin/gunicorn -c gunicorn_conf.py -b 0.0.0.0:8000 main:app
 
 
 [Install]