From 9f938ab8ba5af561bd44dbc7142f338ce317a01a Mon Sep 17 00:00:00 2001 From: Sadeep Madurange Date: Sat, 1 Nov 2025 09:46:52 +0800 Subject: Etlas project. --- README.txt | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.txt (limited to 'README.txt') diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..1067427 --- /dev/null +++ b/README.txt @@ -0,0 +1,21 @@ +SERVER.FCGI + +The server.fcgi file contains the server code for Atlas. Follow the steps below +to deploy Atlas to an OpenBSD server using httpd. + + 1. Install flask, flup, and requests Python packages. + 2. Create directory /var/www/etlas with server.fcgi and tickers.txt. + 3. Set the POLYGON_API_KEY environment variable. + 4. Change ownership of /var/www/run temporarily (to create etlas.sock): + # chown -R www:www /var/www/run + 5. Start FastCGI server: $ doas -u www nohup python3 server.fcgi & + 6. Restore ownership of /var/www/run: + # chown -R root:daemon /var/www/run + 7. Configure httpd (see scripts/httpd.conf for a template). + 8. Create API user: + # mkdir /var/www/htdocs/etlas + # htpasswd /var/www/htdocs/etlas/.htpasswd + 9. Set permissions for .htpasswd: + # chown www:www /var/www/htdocs/etlas/.htpasswd + # chmod u-w /var/www/htdocs/etlas/.htpasswd + 10. Start httpd: # rcctl -f start httpd -- cgit v1.2.3