Skip to content

Commit 2f4bcc8

Browse files
committed
Update online docs for 3.0.21.0 release.
1 parent 49ec758 commit 2f4bcc8

File tree

3 files changed

+89
-21
lines changed

3 files changed

+89
-21
lines changed

docs/PsychLicenseHandling.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ use period to its maximum duration. When connected to the internet,
4848
Psychtoolbox will sync with the server at the first use in a session and
4949
periodically every few hours.
5050

51+
If your local environments firewall prevents online license management from
52+
working, see the section at the bottom for how to add firewall exception rules
53+
to make it work anyway. Below that section you will also find instructions for
54+
operating in a fully offline "air gapped" environment without any internet access.
55+
The latter may require specially configured licenses, as our default licenses do
56+
not support fully offline use.
5157

5258
# Subfunctions and their meaning
5359

@@ -100,6 +106,64 @@ machine has a properly paid, valid and active license associated with it.
100106
Our professional support personnel may ask you to provide such a token in
101107
some cases.
102108

109+
[PsychLicenseHandling](PsychLicenseHandling)('News');
110+
- Print latest stored news about Psychtoolbox, and also specifically related to
111+
this license and activations. Psychtoolbox prints those messages automatically
112+
once when they are new. This function will print them even if they have been
113+
printed before.
114+
115+
116+
# USE IN STRICTLY FIREWALLED ENVIRONMENTS
117+
118+
If your firewall is blocking internet connections to our license servers,
119+
you can configure it as follows to allow connecting to the license servers.
120+
Follow the most recent instructions on this website for passthrough for EU data centers:
121+
122+
https://docs.cryptlex.com/node-locked-licenses/proxies-and-firewall\#for-our-eu-data-center
123+
124+
As of March 2025, the following configuration would be needed, but check above
125+
website for up to date informations if in doubt:
126+
127+
### The following IP addresses and URL should be whitelisted:
128+
129+
IP Addresses to Whitelist:
130+
75.2.113.112
131+
99.83.149.57
132+
133+
Web API URL to Whitelist:
134+
https://api.eu.cryptlex.com:443
135+
136+
# OFFLINE USE IN AIR GAPPED ENVIRONMENTS
137+
138+
Some non-standard software subscription licenses allow offline activation and
139+
deactivation by use of the customer portal and passing forth and back offline
140+
activation and deactivation request and response files. This allows use in air-
141+
gapped environments without access to the public internet or to our license
142+
servers. If your purchased license supports this, the functions are as follows:
143+
144+
[PsychLicenseHandling](PsychLicenseHandling)('ActivateEnrolledKeyOffline', pathToOfflineRequestResponseFile);
145+
- Either create an offline activation request file under the specified path/filename,
146+
which allows creation of an offline activation response file in the customer portal,
147+
or reads such an offline activation response file and activates your local machine.
148+
149+
E.g., after enrolling a license key via [PsychLicenseHandling](PsychLicenseHandling)('Setup') or
150+
[PsychLicenseHandling](PsychLicenseHandling)('Activate', licenseKey); do the following:
151+
152+
1. [PsychLicenseHandling](PsychLicenseHandling)('ActivateEnrolledKeyOffline', 'offlineRequest.dat');
153+
154+
2. Login to customer portal and upload 'offlineRequest.dat' to create offline
155+
response file, downloaded to the file 'offlineResponse.dat'.
156+
157+
3. [PsychLicenseHandling](PsychLicenseHandling)('ActivateEnrolledKeyOffline', 'offlineResponse.dat') to
158+
activate this machine.
159+
160+
[PsychLicenseHandling](PsychLicenseHandling)('DeactivateEnrolledKeyOffline', pathToOfflineProofFile);
161+
- Deactivate the machine locally and write a deactivation proof file into the
162+
path/filename 'pathToOfflineProofFile'. You can upload that proof file into
163+
the customer portal to deactivate the machine in the license servers, so the
164+
machine activation that has been freed up can be reused on a different machine.
165+
Not all licenses allow offline deactivation of once activated machines.
166+
103167

104168

105169

docs/PsychPaidSupportAndServices.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
If you are using a Psychtoolbox variant and version that requires a paid
66
software license key to function, e.g., on Microsoft Windows or Apple
77
macOS, then a few minutes of basic support per year for basic questions
8-
may be included in the specific type of software license you bought. If,
9-
when, and how much support will be provided is usually at the discretion
8+
may be included in the specific type of software license you bought. If
9+
at all, when, and how much support will be provided is at the discretion
1010
of the Psychtoolbox team. In any case, if you wanted to ask for this
1111
basic support, you'd have to present an authentication token by running
1212
this function, or by calling [PsychLicenseHandling](PsychLicenseHandling)('AuthenticationToken').
1313

14-
If you require additional paid support regarding Psychtoolbox, or custom feature
15-
development (or if you want to buy a Psychtoolbox themed coffee mug, bag or shirt)
16-
go to the following website which provides such services:
14+
If you require additional paid support regarding Psychtoolbox, or custom
15+
feature development (or if you want to buy a Psychtoolbox themed coffee
16+
mug, bag or shirt) go to the following website which provides such services:
1717

1818
https://www.psychtoolbox.net
1919

@@ -94,9 +94,9 @@ Psychtoolbox to be around and in good shape years into the future.
9494
To clarify: Psychtoolbox itself will stay open-source software. Anybody
9595
able and willing to contribute code and ideas of sufficiently high quality
9696
is invited to contribute to the open-source code, the documentation on our
97-
public community website and Wiki
98-
http://psychtoolbox.org, and to participate and help each other on the
99-
public community forum https://psychtoolbox.discourse.group.
97+
public community website and Wiki http://psychtoolbox.org, and to participate
98+
and help each other on the public community forum under:
99+
https://psychtoolbox.discourse.group
100100

101101
Support by our developers will be reserved to paying community members.
102102

docs/Psychtoolbox.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
##### >[Psychtoolbox](Psychtoolbox)
33

44
Psychtoolbox.
5-
Version 3.0.20 13 December 2024
5+
Version 3.0.21 31 March 2025
66

77
The Psychophysics Toolbox is a collection of Octave and Matlab functions
88
that extend the language to give you exquisite control of your computer
@@ -99,21 +99,25 @@ Perception 36 ECVP Abstract Supplement.
9999

100100
### IMPORTANT NEWS:
101101

102-
You can now financially contribute to Psychtoolbox sustainability, upkeep
103-
and continued improvement by buying a "Psychtoolbox Support Membership", which
104-
also includes some paid support for questions regarding its use, or issues
105-
you may have with it. We also offer paid feature development and other
106-
useful commercial services.
102+
If you need paid support, you can buy a "Psychtoolbox Paid Support
103+
Membership". We also offer paid feature development and other useful
104+
commercial services.
107105

108106
Please type 'PsychPaidSupportAndServices' to learn more.
109107

110-
Psychtoolbox for Apple macOS and Microsoft Windows will require a paid software
111-
license key to work very soon, likely starting sometime in January 2025. Until
112-
then you can use it with a free time-limited trial license. Psychtoolbox will
113-
connect to our network licensing servers after installation and after you have
114-
given consent, to enable you to use it. For more information about this, type
115-
'help PsychLicenseHandling'. Stay tuned for our announcement of start of sales
116-
for these software license keys in early 2025.
108+
Psychtoolbox mex files for Apple macOS and Microsoft Windows will require
109+
a paid software license key to work, starting in April 2025. Already
110+
existing and active installations of Psychtoolbox 3.0.20 or later from
111+
before April will be usable with a free time-limited trial license until
112+
14th April 2025. New first time installations of Psychtoolbox on a
113+
machine, starting at 31st of March 2025, will work for free for up to 14
114+
days after first use. After that time period, a paid subscription license
115+
will be required.
116+
117+
Psychtoolbox on macOS and Windows will connect to our network licensing
118+
servers after installation and after you have given consent, to enable
119+
you to use it. For more information about our license management, type
120+
'help PsychLicenseHandling'.
117121

118122

119123

0 commit comments

Comments
 (0)