aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSami Littow <sami.littow@qt.io>2023-01-02 08:35:40 +0200
committerSami Littow <sami.littow@qt.io>2023-01-02 08:35:40 +0200
commitcd8509d3b5c91d93b16b3f6da2e760632cb49e67 (patch)
tree4cc97e0915bd487eb7ce9c9ddcf1312eda252181
parentef625f89a2d8e66a7a8f484279e67e54fa100ee9 (diff)
Some README updates
-rw-r--r--INSTALL_linux.txt14
-rw-r--r--INSTALL_win.txt20
-rw-r--r--README.md23
3 files changed, 30 insertions, 27 deletions
diff --git a/INSTALL_linux.txt b/INSTALL_linux.txt
index 406b4e4..b9e3375 100644
--- a/INSTALL_linux.txt
+++ b/INSTALL_linux.txt
@@ -19,7 +19,7 @@ To build, run the build script: (from project root)
cd to deploy/ directory (created by build.sh):
cd deploy
-At this point, you might want to edit the licd.ini file, where most important is the License Server address to be able to connect to it. If you do this later, you need to edit /opt/licd.ini as root. See licd.ini in deploy directory.
+At this point, you might want to edit the qtlicd.ini file, where most important is the License Server address to be able to connect to it. If you do this later, you need to edit /opt/qtlicd.ini as root. See qtlicd.ini in deploy directory.
Run installation script as root:
sudo ./installer.sh
@@ -29,26 +29,26 @@ Run installation script as root:
To get MOC wrapper working, too, please note: Installation script does not know your Qt installation location (Something like /home/user/Qt/6.3.1/gcc_64/libexec/). That's why you need to set MOC wrapper working by doing:
1. cd [your Qt framework install dir]
2. mv moc orig_moc <--- Note: has to be exactly 'orig_moc'
- 3. ln -s /opt/licd/mocwrapper moc
+ 3. ln -s /opt/qtlicd/mocwrapper moc
4. Try it by building any Qt-enabled app wit any IDE or from command line
In case youre using Qt5, you need to enable legacy support for its qmake licensing system by replacing licheck binary with the provided one:
(Still in the Qt installation location):
1. cp licheck licheck.bak <--- This is just to back up the original, you can name it freely
- 2. ln -s /opt/licd/licheck licheck
+ 2. ln -s /opt/qtlicd/licheck licheck
Check if the service running:
- sudo systemctl status licd
+ sudo systemctl status qtlicd
To stop it:
- sudo systemctl stop licd
+ sudo systemctl stop qtlicd
to disable it:
- sudo systemctl disable licd
+ sudo systemctl disable qtlicd
To view logs:
- journalctl -u licd -n 100
+ journalctl -u qtlicd -n 100
(Displays last 100 lines. If -n is not given, it will show all the logs)
To completely uninstall, run 'uninstaller.sh' from deploy directory (as root, of course)
diff --git a/INSTALL_win.txt b/INSTALL_win.txt
index 7ede120..9e9c1dc 100644
--- a/INSTALL_win.txt
+++ b/INSTALL_win.txt
@@ -19,16 +19,16 @@ Put "cmd" in the search box right next to the windows start menu, right click on
In the command prompt, start the build script by typing:
> build_windows.bat
-Edit the licd.ini file under <project root>\deploy to match your system setup
+Edit the qtlicd.ini file under <project root>\deploy to match your system setup
From this point forward, you need to be an admin. So if you didn't do so already, open the command prompt as an administrator.
Go back to the <project root>\deploy directory:
> cd .. (from build dir if still there)
> cd deploy
- > copy *.* "C:\Program Files\licd\"
+ > copy *.* "C:\Program Files\qtlicd\"
And install the service:
- > C:\"Program Files"\licd\licd --install
+ > C:\"Program Files"\qtlicd\qtlicd --install
Possible error messages:
"OpenSCManager failed (5)" <<-- You're not an admin, re-open the Command Prompt as administrator.
"CreateService failed (1073)" <<-- Service is already installed/running. See below how to stop and delete
@@ -41,25 +41,25 @@ Like with Linux version, you now need to get the MOC-wrapper and Qt5 licheck bin
(For example, my path is: "C:\Qt\6.3.1\mingw_64\bin)
> cd <Qt instalation binary path>
> move moc.exe orig_moc.exe <--- Name MUST be orig_moc.exe
- > mklink moc.exe "C:\Program\files\licd\mocwrapper.exe"
+ > mklink moc.exe "C:\Program\files\qtlicd\mocwrapper.exe"
- And the same for licheck, if you're using Qt5:
> move licheck.exe licheck_bak.exe <---- Name it freely
- > mklink licheck.exe "C:\Program\files\licd\licheck.exe"
+ > mklink licheck.exe "C:\Program\files\qtlicd\licheck.exe"
-If you use a lot of command line, you may like to add "C:\Program Files\licd\" yo your PATH variable for convenience.
+If you use a lot of command line, you may like to add "C:\Program Files\qtlicd\" yo your PATH variable for convenience.
============ Starting/stopping the service:
In Windows start menu search, type:
"Services"
Icon with name "Services" should appear. Open it, and a list of system services should now be seen.
-Scroll down until you see "licd". Click it to activate, and then click "Start the service" near upper left corner of the window.
+Scroll down until you see "qtlicd". Click it to activate, and then click "Start the service" near upper left corner of the window.
From the same place, you also can stop it whenever needed.
============ Uninstall:
From Administrator Command propmt, call the lidc as follows:
- > C:\"Program Files"\licd\licd --delete
-The licd service disappears from the Windows Services and you now can do re-installation if needed.
+ > C:\"Program Files"\qtlicd\qtlicd --delete
+The qtlicd service disappears from the Windows Services and you now can do re-installation if needed.
Please note that this does NOT delete the program itself, it's still in its designated folder.
-To completely remove it, just destroy the "c:\Program Files\licd" directory and replace the orig_moc and licheck binaries with the originals.
+To completely remove it, just destroy the "c:\Program Files\qtlicd" directory and replace the orig_moc and licheck binaries with the originals.
diff --git a/README.md b/README.md
index 8829c86..2bb7404 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ Daemon talks to the server via HTTP, with data moving back and worth in JSON for
For installation/running, see each system's respective INSTALL_xxx.txt files.
----------- The user settings file ---------
+# The user settings file
The settings file 'qtlicenseservice.ini' is created automatically in user's Qt home folder which usually is in:
Linux: <your home dir>/.local/share/Qt/qtlicenseservice.ini
@@ -22,15 +22,16 @@ To create it from scratch, run either mocwrapper or qtlicensetool once (qtlicens
- licd_addr Address to the machine where License Service (daemon) is running. In many cases, localhost is correct.
- licd_port Daemon port - default is 60000. Check from daemon settings file or ask the admin
- # MOC-wrapper/moc
+ -- MOC-wrapper/moc
+
From now on, moc will take the [default] section in use if there's no installation-specific section available. New section names will be determined by current Qt framework installation path. Thats why its mandatory to call moc with absolute path on the second run - easisest way to do that is to just start building some Qt app, as the build procedure always calls moc with absolute path.
You'll be informed about the creation of the new section under which the defaults are copied at this point. In case you have multiple instances/versions of the Qt framework, you'll have invividual sections for each of them.
- # qtlicensetool
+ -- qtlicensetool
qtlicensetool ALWAYS reads its settings from the [default] section, no matter where it's being run from.
----------- Setup and Usage ----------
+# Setup and Usage
At first, start Qt License Server on some Windows machine
@@ -46,13 +47,16 @@ Start the daemon, as described in respective Linux/Windows INSTALL file.
> qtlicd.exe --nodaemon (Windows)
- You now can see immediately what happens in there. Stop like any other app with Ctrl-C
- Note that where ever you start qtlicd, it will always read settings from installation folder.
- # MOC-wrapper
+
+-- MOC-wrapper
+
If the setup is made correct (moc binary changed to the link pointing to mocwrapper), MOC license checks should happen in backround without any user actions, each time a build is being done.
You can ask mocwrapper version with:
> ./mocwrapper --version (mocwrapper.exe in Windows)
-# qtlicensetool
+-- qtlicensetool
+
Old 'qtlongterm' has now been replaced bu a new, more generic tool to handle more Qt licensing-related checks and actions. I'ts still a CLI tool, and has a format:
qtlicensetool <Action> [params]
Where 'Action' is:
@@ -67,24 +71,23 @@ Start the daemon, as described in respective Linux/Windows INSTALL file.
-d = Full license daemon address and port separated by ':'
-u = Your Qt license username
-i = Your Qt license ID number (must be an int)
- -l = License server address and port separated by ':'
Example:
> qtlicensetool --longterm add : Make a long-term license reservation
> qtlicensetool -L add -i 462412 : Same as above, but using different license ID
> qtlicensetool --daemonversion : Prints out a daemon version number
-# To test MOC and plugin interfaces without actually using MOC or Qt Creator (plugin):
+-- To test MOC and plugin interfaces without actually using MOC or Qt Creator (plugin):
+
Use any TCP/IP-enabled app to connect to localhost's port 60000 (or whichever is stated in qtlicd.ini). For example, with telnet:
telnet localhost 60000
After connecting, issue a command like:
license -u foobar -a QtCreator -v 6.3 -i 123456
Where: -u = username, -a = app in use, -v app version and -i Qt license ID
- Optionally, you can also give -l switch followed by license server address, like: -l 10.0.10.234:8080
Reply is then info txt about having/not having a valid license, or "Bad request" for malformed message.
----------- Version info ----------
+# Version info ----------
From each component included, you can ask their version using --version switch as follows:
[app name] --version <--- [app name].exe in Windows, of course