Online Package Manager: what changed

Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		## About
2	2
3	3		Online Package Manager(OPM) is a tool that automates the process of installing, upgrading, configuring Lazarus packages. The packages are stored in the main repository(see repository column) as zip files, along with a [[JSON]] file. The JSON contains all necessary information about the packages. On request the packages are downloaded/extracted/compiled/installed into the IDE. If available, it's also possible to update a previously installed package from the maintainer webpage(see update column). There's also a web version of the Lazarus Packages Repository available here: <http://packages.lazarus-ide.org/>.
4	4
5		-	~~<span style="color:red">Please note:</span>~~
	5	+	Please note:
6	6
7	7		OPM reads the package description from the lpk file. I can understand that the description of many packages is very minimalistic or even non-existent, but there is nothing I can do about it. It's not OK to modify package description or any other property for that matter, without the consent of the package developer. More over testing each and every package, then write a detailed description is not realistic.
8	8
9	9		### Screenshot
10	10
11		-	~~<figure>~~
12		-	~~<img src="OPM6.png" title="OPM6.png" />~~
13		-	~~<figcaption>OPM6.png</figcaption>~~
14		-	~~</figure>~~
	11	+	![](/wiki-images/6/6e/OPM6.png)
15	12
16		-	~~<figure>~~
17		-	~~<img src="OPM7.png" title="OPM7.png" />~~
18		-	~~<figcaption>OPM7.png</figcaption>~~
19		-	~~</figure>~~
	13	+	![](/wiki-images/b/b7/OPM7.png)
20	14
21	15		### License
22	16
23	17		[GNU General Public License](https://opensource.org/licenses/gpl-license)
24	18
25	19		### Download
26	20
27	21		Online package manager is part of Lazarus sources, in directory (\$LazarusDir)/components/onlinepackagemanager.
28	22
29	23		### System Requirements / Dependencies
30	24
31	25		- FPC 3.0.0 or newer
32	26		- Lazarus 1.8 or newer
33	27		- You can download an older version for the 1.6 series: [OPM 1.6](https://drive.google.com/open?id=0B9Me_c5onmWobVZOdVlXSlZRRmc)
34	28		- These versions were available at the time of writing this update.
35	29		- Tested on the following widgeset: win32/64, gtk2, carbon, qt(win)
36	30		- The package manager does not depend on any external package
37	31
38	32		### Installation
39	33
40	34		In Lazarus "Install/Uninstall Packages" window select "OnlinePackageManager" from the available packages, click "Install selection" and then rebuild the IDE.
41	35
42	36		### Support page
43	37
44	38		<http://forum.lazarus.freepascal.org/index.php/topic,34297.0.html>
45	39
46	40		## Using the package manager
47	41
48	42		### Getting started
49	43
50		-	Go to Lazarus Menu--\>Package--\>Online Package Manager(Shortcut key: <span class="kbd">Ctrl</span>+<span class="kbd">Alt</span>+<span class="kbd">Shift</span>+<span class="kbd">O</span>). On startup the package manager will automatically download a list with available repository packages, the list is displayed in a tree(see screenshots above).
	44	+	Go to Lazarus Menu--\>Package--\>Online Package Manager(Shortcut key: `Ctrl`+`Alt`+`Shift`+`O`). On startup the package manager will automatically download a list with available repository packages, the list is displayed in a tree(see screenshots above).
51	45
52	46		### Filter the tree/Locate a package
53	47
54		-	~~<figure>~~
55		-	~~<img src="OPM3.png" title="OPM3.png" />~~
56		-	~~<figcaption>OPM3.png</figcaption>~~
57		-	~~</figure>~~
	48	+	![](/wiki-images/b/b3/OPM3.png)
58	49
59	50		You can filter the package list by:
60	51
61	52		- Packagename
62	53		- Package file(.lpk)--\>a repository package can contain multiple lpk files
63	54		- Package category
64	55		- Package status
65	56		- Version
66	57		- Description
67	58		- Author
68	59		- Lazarus compatibility
69	60		- FPC compatibility
70	61		- Supported widget sets
71	62		- Packagetype
72	63		- Dependencies
73	64		- License
74	65
75	66		### Operation with packages
76	67
77		-	~~<figure>~~
78		-	~~<img src="OPM4.png" title="OPM4.png" />~~
79		-	~~<figcaption>OPM4.png</figcaption>~~
80		-	~~</figure>~~
	68	+	![](/wiki-images/a/a5/OPM4.png)
81	69
82	70		#### Refresh package list
83	71
84	72		Press the "Refresh" button to update the package list.
85	73
86	74		#### Download package
87	75
88	76		Check one or more package then press the "Download" button. This will download/extract the packages to a preselected directory. Nothing gets installed. Useful when you want to install the packages manually or study their sources without installing.
89	77
90	78		#### Install a package
91	79
92	80		Check one or more package then press the "Install" button. The package manager will automatically download/extract/compile/install the selected packages(from the main repository), then rebuild the IDE if necessary(Designtime/Designtime_and_runtime packages). Confirm the rebuild by clicking the "Yes" button. Please note: The compile feature is only available in Lazarus 1.7+.
93	81
94	82		#### Update a package
95	83
96		-	Check one or more package then press the "Update" button. The package manager will update the selected packages from the maintainer's homepage(if available). The package must be installed first, a direct update although is possible, it's not allowed to prevent unresolved dependency error. <span style="color:red">Please note:</span> downloading/installing packages from external link is not without a risk. Only update the package if you trust the package maintainer.
	84	+	Check one or more package then press the "Update" button. The package manager will update the selected packages from the maintainer's homepage(if available). The package must be installed first, a direct update although is possible, it's not allowed to prevent unresolved dependency error. Please note: downloading/installing packages from external link is not without a risk. Only update the package if you trust the package maintainer.
97	85
98	86		#### Difference between download/install/update
99	87
100	88		Download/Install --\> Operations between you and the main repository.
101	89
102	90		Update --\> Operations between you and the package maintainers.
103	91
104		-	~~<figure>~~
105		-	~~<img src="OPM10.png" title="OPM10.png" />~~
106		-	~~<figcaption>OPM10.png</figcaption>~~
107		-	~~</figure>~~
	92	+	![](/wiki-images/6/61/OPM10.png)
108	93
109	94		Video link: [Difference between download/install/update](https://www.youtube.com/watch?v=wiN2GoCvgjc)
110	95
111	96		#### Cleanup local repository
112	97
113	98		This operation will delete all non-installed packages/archives from the local repository. To cleanup the local repository press the "Cleanup" button.
114	99
115	100		#### Create
116	101
117	102		This section is for package maintainers. First you must go to Options--\>Profiles and select package maintainer.
118	103
119	104		##### Create repository package
120	105
121	106		To create a repository package press "Create repository package" menu item, then:
122	107
123	108		- select the package main directory(package manager will recursively search for all package files inside the folder)
124	109		- select the repository package(root node)
125	110		- choose category(obligatory)
126	111		- type display name(optional)
127	112		- home page(optional)
128	113		- update link(optional, for more details see "Create JSON for updates"[1](http://wiki.freepascal.org/Online_Package_Manager#Create_JSON_for_updates)" below)
129	114		- create JSON for updates(optional), has the same functionality as "Create JSON for updates"[2](http://wiki.freepascal.org/Online_Package_Manager#Create_JSON_for_updates)" dialog. It was also added here to speed up the process.
130	115
131		-	~~<figure>~~
132		-	~~<img src="OPM15.png" title="OPM15.png" />~~
133		-	~~<figcaption>OPM15.png</figcaption>~~
134		-	~~</figure>~~
	116	+	![](/wiki-images/6/6c/OPM15.png)
135	117
136	118		- check each package you wish to include, adjust package info if necessary(lazarus/fpc compatibility, supported widgetset, etc)
137	119
138		-	~~<figure>~~
139		-	~~<img src="OPM16.png" title="OPM16.png" />~~
140		-	~~<figcaption>OPM16.png</figcaption>~~
141		-	~~</figure>~~
	120	+	![](/wiki-images/6/6d/OPM16.png)
142	121
143	122		- press the create button, if all goes well you should get a zip and a json file. Upload somewhere the files and send the link to opm@lazarus-ide.org or
144	123		- press the submit button, the files are directly uploaded to a remote server.
145	124
146	125		Every package will be accepted after a short check(malware, license, etc). Multiple versions of the same package is also allowed.
147	126
148	127		##### Create JSON for updates
149	128
150	129		To allow the user to update the package directly form your webpage, follow this steps:
151	130
152	131		- Make sure your package is already in the main repository(see previous section)
153	132		- You can download and use the [[OPM External Update json Editor\|Online Package Manager External Update json Editor]]
154	133		- or via OnlinePackageManager:
155	134
156	135		- Check the package, press the "Create JSON for upates" menu item then create the JSON.
157	136
158		-	~~<figure>~~
159		-	~~<img src="OPM11.png" title="OPM11.png" />~~
160		-	~~<figcaption>OPM11.png</figcaption>~~
161		-	~~</figure>~~
	137	+	![](/wiki-images/d/d1/OPM11.png)
162	138
163	139		- Edit the JSON, upload to your webpage, then send me the link.
164	140
165	141		The JSON will look like this:
166	142
167		-	~~<figure>~~
168		-	~~<img src="OPM12.png" title="OPM12.png" />~~
169		-	~~<figcaption>OPM12.png</figcaption>~~
170		-	~~</figure>~~
	143	+	![](/wiki-images/0/09/OPM12.png)
171	144
172	145		Editable items in the JSON:
173	146
174	147		"DownloadZipURL" --\> Link to your new, updated package
175	148
176	149		"DisableInOPM" --\> If you want to temporary disable your package, set this boolean to true. It's useful for maintenance, the package will be grayed out in the tree. The user cannot download/install/update the package.
177	150
178	151		"Version"/"ForceNotify"/"InternalVersion" --\> To trigger an update message on the users computer, you can either:
179	152
180	153		- Increase the "Version" number. Useful when you want to release a new version of the package.
181	154		- Set "ForceNotify" to true. Useful after a minor change in your source, that does not require a version change or in case of trunk version. To prevent continous error messages, "ForceNotify" must be used in combination with "InternalVersion". After the user updates the package, OPM locally stores the "InternalVersion" value. If you want to trigger a new message, increase "InternalVersion" with one. If "ForceNotify" is true, "Version" is always ignored.
182	155
183	156		The most common scenario is this:
184	157
185	158		- Generate the JSON
186	159		- Modify "DownloadZipURL"
187	160		- Increase version number when necessary.
188	161
189	162		Please note: After you edited the JSON the changes are not immediately visible in the tree. Usually it takes 1-2 min. It also depends on the users setting(Options--\>General--\>Check for package updates).
190	163
191	164		#### Options
192	165
193	166		To display the options dialog press the "Options" button.
194	167
195	168		### Create a private repository
196	169
197	170		In order to create a private repository please do the following:
198	171
199	172		1\. First make sure profile "Package maintainer" is enabled in Options--\>Profiles, then open the private repository form(see screenshot below)
200	173
201		-	~~<figure>~~
202		-	~~<img src="OPM17.png" title="OPM17.png" />~~
203		-	~~<figcaption>OPM17.png</figcaption>~~
204		-	~~</figure>~~
	174	+	![](/wiki-images/b/b0/OPM17.png)
205	175
206	176		2\. Press the "Create" button. Enter repository Name, Address(optional), Description(optional). Save the repository to an empty folder
207	177
208		-	~~<figure>~~
209		-	~~<img src="OPM18.png" title="OPM18.png" />~~
210		-	~~<figcaption>OPM18.png</figcaption>~~
211		-	~~</figure>~~
	178	+	![](/wiki-images/c/c7/OPM18.png)
212	179
213	180		- If filled, the repository address(in this case <http://localhost/packages/>) is automatically added to available repository list(Options form)
214	181
215		-	~~<figure>~~
216		-	~~<img src="OPM19.png" title="OPM19.png" />~~
217		-	~~<figcaption>OPM19.png</figcaption>~~
218		-	~~</figure>~~
	182	+	![](/wiki-images/8/8e/OPM19.png)
219	183
220	184		3\. Start to add/delete packages. You have two choices:
221	185
222	186		a\. Create a new package via <http://wiki.freepascal.org/Online_Package_Manager#Create_repository_package>
223	187
224	188		b\. Add a previously saved package
225	189
226		-	~~<figure>~~
227		-	~~<img src="OPM20.png" title="OPM20.png" />~~
228		-	~~<figcaption>OPM20.png</figcaption>~~
229		-	~~</figure>~~
	190	+	![](/wiki-images/5/5b/OPM20.png)
230	191
231	192		4.You can also open a previously saved repository. The last repository is automatically opened on startup.
232	193
233	194		5.Upload the files(packagelist.json, *.zip) to your local or remote server.
234	195
235	196		6.Make sure the server is running, the change "Remote repository" in Options--\>General
236	197
237	198		## see also
238	199
239	200		- [OPM video about the install process](https://www.youtube.com/watch?v=IRJkyiOn3AA)
240	201
241	202		---
242	203		From the Free Pascal wiki, page "Online Package Manager", as it stood on 2020-04-28 after a change by GetMem, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).

Back to history