You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,15 +33,17 @@ For more details see:
33
33
To install the RPI ws281x library:
34
34
35
35
pip3 install rpi_ws281x
36
-
36
+
37
37
To install the Argon hash algorithm
38
38
39
39
sudo apt install python3-argon2
40
40
41
41
To install the Flask CSRF protection
42
+
42
43
pip3 install Flask-WTF
43
-
44
-
To be able to run the tests
44
+
45
+
To be able to run the tests
46
+
45
47
sudo apt install python3-pytest
46
48
47
49
@@ -72,9 +74,9 @@ For more information see: [Penguin Tutor guide to starting programs automaticall
72
74
73
75
# Security
74
76
75
-
The pixel server is designed to support varying levels of security depending upon your system requirements.
77
+
The pixel server is designed to support varying levels of security depending upon your system requirements.
76
78
77
-
If used on a private only network then it can be configured for network address authentication.
79
+
If used on a private only network then it can be configured for network address authentication.
78
80
79
81
If allowing incoming connections from the Internet then it is recommended that user authentication is enabled and it is configured through SSL. The configuration below is based on using Nginx as a reverse proxy to provide HTTPS using a LetsEncrypt certificate.
80
82
@@ -103,7 +105,7 @@ ln -s to /etc/nginx/sites-enabled
103
105
104
106
105
107
Add the following in a location file (this assumes using /rpi1/ as the route
106
-
for this particular server.
108
+
for this particular server.
107
109
108
110
location /rpi1/ {
109
111
proxy_set_header X-Real-IP $remote_addr;
@@ -208,7 +210,7 @@ SK6812W_STRIP
208
210
Controls authentication. Can have one or more of the following, which can be a single IP address, or a network subnet, multiple addresses or network subnets (comma seperated) or 0.0.0.0 (all addresses)
209
211
Multiple entries will be appended to the access.
210
212
211
-
proxy_server =
213
+
proxy_server =
212
214
Any addresses in this range will be treated as proxy servers.
213
215
If the proxy server has X-Real-IP set then that will be used instead of the local ip address of the server. Warning if that is not a proxy server then this
214
216
could be a security risk (in terms of allowing non authenticated logins). Cannot be 0.0.0.0 (everywhere is a proxy doesn't make sense) - normally this will be specific IP address rather than range.
@@ -265,4 +267,4 @@ If upgrading from a version prior to July 2022 then you may need to create a new
265
267
Currently supports limited automated testing based around the authentication. This is achieved using:
266
268
py.test-3
267
269
268
-
Manual testing is required for all other functions.
270
+
Manual testing is required for all other functions.
adminuser1:$5$1883d31e1d394719b2eab0b9b2c786bc$743be7524ea18ca3fbc53333d0cec4cfd20e115045ddb455f30d1bcf3df2621d:Admin user real name:admin:user@example938.com:Admin user sha256
4
+
stduser2:$5$1948a2047f5743c4a64bde92919d3eec$25670be86447039a5e126fc8acaac5e4ee4bd7805fcb493074ea9877be03088c:Standard user real name:standard:stduser2@nouser.ex543.com:Standard user sha256
0 commit comments