I2P_Developers/i2p.i2p
3
1
Fork 11
Code Issues 340 Pull Requests 7 Actions 2 Packages Projects Releases Wiki Activity

Make Desktop File for Linux Install #476

New Issue
Open
opened 2025-04-21 15:11:15 -04:00 by idk · 14 comments
idk commented 2025-04-21 15:11:15 -04:00
Owner
Copy Link

Opened 4 years ago

Last modified 4 years ago

#1928openenhancement

Make Desktop File for Linux Install

Reported by:lazygravyOwned by:lazygravy
Priority:
minor
Milestone:
0.9.29
Component:
installer
Version:
0.9.28
Keywords:
usability
Cc:

Parent Tickets:

Sensitive:
no

Description

I saw a post on Reddit where a user was saying they couldn't figure out how to start I2P on his Linux install. I suggest we include an i2p.desktop file with Linux installs.

The desktop file seems to work with Debian and Fedora. I am not sure how many distributions/desktop environments we should target.

Relevant documentation: ​https://developer.gnome.org/integration-guide/stable/desktop-files.html.en

Subtickets

Opened [4 years ago](/timeline?from=2017-01-14T21%3A00%3A51Z&precision=second "See timeline at Jan 14, 2017 9:00:51 PM") Last modified [4 years ago](/timeline?from=2017-02-01T15%3A18%3A05Z&precision=second "See timeline at Feb 1, 2017 3:18:05 PM") ## [\#1928](/ticket/1928)[open](/query?status=open)[enhancement](/query?status=!closed&type=enhancement) # Make Desktop File for Linux Install Reported by:[lazygravy](/query?status=!closed&reporter=lazygravy)Owned by:[lazygravy](/query?status=!closed&owner=lazygravy) Priority: [minor](/query?status=!closed&priority=minor) Milestone: [0.9.29](/milestone/0.9.29 "Completed 4 years ago (Feb 27, 2017 12:00:00 PM)") Component: [installer](/query?status=!closed&component=installer) Version: [0.9.28](/query?status=!closed&version=0.9.28) Keywords: [usability](/query?status=!closed&keywords=~usability) Cc: Parent Tickets: Sensitive: [no](/query?status=!closed&sensitive=0) ### Description I saw a post on Reddit where a user was saying they couldn't figure out how to start I2P on his Linux install. I suggest we include an i2p.desktop file with Linux installs. The desktop file seems to work with Debian and Fedora. I am not sure how many distributions/desktop environments we should target. Relevant documentation: [​https://developer.gnome.org/integration-guide/stable/desktop-files.html.en](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) ### Subtickets
idk added this to the 0.9.29 milestone 2025-04-21 15:11:15 -04:00
idk added the
#1928
0.9.29
installer
 labels 2025-04-21 15:11:15 -04:00
idk self-assigned this 2025-04-21 15:11:15 -04:00
idk commented 2025-04-21 15:11:16 -04:00
Author
Owner
Copy Link

comment:11 Changed 4 years ago by zzz

One misery with custom panels is translations, although perhaps we could use the same strings as ShortcutPanel?.

[comment:11](https://trac.i2p2.de/\#comment:11) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-02-01T15%3A18%3A05Z&precision=second "See timeline at Feb 1, 2017 3:18:05 PM") by zzz One misery with custom panels is translations, although perhaps we could use the same strings as ShortcutPanel?.
idk commented 2025-04-21 15:11:16 -04:00
Author
Owner
Copy Link

comment:10 Changed 4 years ago by zzz

re: non-Deb installs, that's the problem with doing it manually instead of with ShortcutPanel?. The options are:

  • Don't install it automatically for non-deb installs, this change is only for packages

  • Always install it automatically for non-deb installs

  • Figure out how to fix ShortcutPanel?, either by patching our current 4.3.0, or upgrading to 4.3.5 or 5.0.0 ( #1864) if there's a fix in there

  • Add a custom panel that reimplements what we need from ShortcutPanel? but without the bugs

First two are easy, last two are hard. We could also start out not installing it, and defer a solution to a later release.

[comment:10](https://trac.i2p2.de/\#comment:10) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-02-01T15%3A11%3A15Z&precision=second "See timeline at Feb 1, 2017 3:11:15 PM") by zzz re: non-Deb installs, that's the problem with doing it manually instead of with ShortcutPanel?. The options are: - Don't install it automatically for non-deb installs, this change is only for packages - Always install it automatically for non-deb installs - Figure out how to fix ShortcutPanel?, either by patching our current 4.3.0, or upgrading to 4.3.5 or 5.0.0 ( [#1864](https://trac.i2p2.de//ticket/1864 "#1864: defect: IzPack 5 (closed: fixed)")) if there's a fix in there - Add a custom panel that reimplements what we need from ShortcutPanel? but without the bugs First two are easy, last two are hard. We could also start out not installing it, and defer a solution to a later release.
idk commented 2025-04-21 15:11:17 -04:00
Author
Owner
Copy Link

comment:9 Changed 4 years ago by lazygravy

Replying to zzz:

  • you didn't attach the new files i2p.desktop and 0004-i2p-desktop.patch for review

Yeah, sorry about that. Brain fart. Attached now.

  • debian patch files are a pain to maintain, if there's a way to avoid it that would be better, but I suspect we'll have to do it

Since the start script will be in /usr/bin/i2pinstall the patch is needed, but it should be easy enough to maintain.

  • unrelated changes readme.license.txt, whitespace changes, debian/control you should just check in, not include here for review

Ack. I need to sign the CLA, but I won't commit those for now.

For now, I keep the .desktop in %INSTALL_PATH. It gets installed globally for Debian, but I wasn't sure what kind of experience should happen for jar installs.

  • I don't think the desktop file needs to be 755 in postinstall.sh, none of the desktop files on my system are executable

For some reason Nautilus won't show the .desktop file as a clickable icon unless I make it u+x. I will experiment further.

[comment:9](https://trac.i2p2.de/\#comment:9) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-02-01T03%3A05%3A35Z&precision=second "See timeline at Feb 1, 2017 3:05:35 AM") by lazygravy Replying to [zzz](https://trac.i2p2.de//ticket/1928#comment:8 "Comment 8"): > - you didn't attach the new files i2p.desktop and 0004-i2p-desktop.patch for review Yeah, sorry about that. Brain fart. Attached now. > - debian patch files are a pain to maintain, if there's a way to avoid it that would be better, but I suspect we'll have to do it Since the start script will be in /usr/bin/i2pinstall the patch is needed, but it should be easy enough to maintain. > - unrelated changes readme.license.txt, whitespace changes, debian/control you should just check in, not include here for review Ack. I need to sign the CLA, but I won't commit those for now. > - I don't see anything that puts the .desktop file in ~/.local/share/applications/ for non-deb installs as specified at [​https://developer.gnome.org/integration-guide/stable/desktop-files.html.en](https://trac.i2p2.de/https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) \- how does it get there? For now, I keep the .desktop in %INSTALL\_PATH. It gets installed globally for Debian, but I wasn't sure what kind of experience should happen for jar installs. > - I don't think the desktop file needs to be 755 in postinstall.sh, none of the desktop files on my system are executable For some reason Nautilus won't show the .desktop file as a clickable icon unless I make it u+x. I will experiment further.
idk commented 2025-04-21 15:11:17 -04:00
Author
Owner
Copy Link

Changed 4 years ago by lazygravy

Attachment:i2p.desktop ​
added

Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-02-01T03%3A02%3A39Z&precision=second "See timeline at Feb 1, 2017 3:02:39 AM") by lazygravy Attachment:[_i2p.desktop_](https://trac.i2p2.de//attachment/ticket/1928/i2p.desktop) [​](https://trac.i2p2.de//raw-attachment/ticket/1928/i2p.desktop "Download") added
idk commented 2025-04-21 15:11:17 -04:00
Author
Owner
Copy Link

Changed 4 years ago by lazygravy

Attachment:0004-i2p-desktop.patch ​
added

Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-02-01T03%3A00%3A59Z&precision=second "See timeline at Feb 1, 2017 3:00:59 AM") by lazygravy Attachment:[_0004-i2p-desktop.patch_](https://trac.i2p2.de//attachment/ticket/1928/0004-i2p-desktop.patch) [​](https://trac.i2p2.de//raw-attachment/ticket/1928/0004-i2p-desktop.patch "Download") added
idk commented 2025-04-21 15:11:17 -04:00
Author
Owner
Copy Link

comment:8 Changed 4 years ago by zzz

  • you didn't attach the new files i2p.desktop and 0004-i2p-desktop.patch for review

  • debian patch files are a pain to maintain, if there's a way to avoid it that would be better, but I suspect we'll have to do it

  • unrelated changes readme.license.txt, whitespace changes, debian/control you should just check in, not include here for review

  • I don't see anything that puts the .desktop file in ~/.local/share/applications/ for non-deb installs as specified at ​https://developer.gnome.org/integration-guide/stable/desktop-files.html.en - how does it get there?

  • I don't think the desktop file needs to be 755 in postinstall.sh, none of the desktop files on my system are executable

[comment:8](https://trac.i2p2.de/\#comment:8) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-01-31T15%3A26%3A49Z&precision=second "See timeline at Jan 31, 2017 3:26:49 PM") by zzz - you didn't attach the new files i2p.desktop and 0004-i2p-desktop.patch for review - debian patch files are a pain to maintain, if there's a way to avoid it that would be better, but I suspect we'll have to do it - unrelated changes readme.license.txt, whitespace changes, debian/control you should just check in, not include here for review - I don't see anything that puts the .desktop file in ~/.local/share/applications/ for non-deb installs as specified at [​https://developer.gnome.org/integration-guide/stable/desktop-files.html.en](https://trac.i2p2.de/https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) \- how does it get there? - I don't think the desktop file needs to be 755 in postinstall.sh, none of the desktop files on my system are executable
idk commented 2025-04-21 15:11:17 -04:00
Author
Owner
Copy Link

Changed 4 years ago by lazygravy

Attachment:trac-1928.diff ​
added

patch

Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-01-31T02%3A42%3A04Z&precision=second "See timeline at Jan 31, 2017 2:42:04 AM") by lazygravy Attachment:[_trac-1928.diff_](https://trac.i2p2.de//attachment/ticket/1928/trac-1928.diff) [​](https://trac.i2p2.de//raw-attachment/ticket/1928/trac-1928.diff "Download") added patch
idk commented 2025-04-21 15:11:18 -04:00
Author
Owner
Copy Link

comment:7 Changed 4 years ago by lazygravy

I decided to go with the manual approach.

I've attached my patch. I want to test it more with Debian before anything is merged.

[comment:7](https://trac.i2p2.de/\#comment:7) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-01-31T02%3A40%3A19Z&precision=second "See timeline at Jan 31, 2017 2:40:19 AM") by lazygravy I decided to go with the manual approach. I've attached my patch. I want to test it more with Debian before anything is merged.
idk commented 2025-04-21 15:11:18 -04:00
Author
Owner
Copy Link

comment:6 Changed 4 years ago by zzz

The good part about using ShortcutPanel? is we get a dialog box in the installer to ask the user if he wants it. The fallback, if you can't get that to work, is just bundling a pre-made desktop file all the time. That's probably fine too, but not ideal. If there are bugs we can't work around, perhaps they are fixed in Izpack 5 #1864 but that could be a lot of work, I think 5 is a lot different.

Sounds like you are making good progress.

[comment:6](https://trac.i2p2.de/\#comment:6) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-01-24T14%3A11%3A54Z&precision=second "See timeline at Jan 24, 2017 2:11:54 PM") by zzz The good part about using ShortcutPanel? is we get a dialog box in the installer to ask the user if he wants it. The fallback, if you can't get that to work, is just bundling a pre-made desktop file all the time. That's probably fine too, but not ideal. If there are bugs we can't work around, perhaps they are fixed in Izpack 5 [#1864](https://trac.i2p2.de//ticket/1864 "#1864: defect: IzPack 5 (closed: fixed)") but that could be a lot of work, I think 5 is a lot different. Sounds like you are making good progress.
idk commented 2025-04-21 15:11:18 -04:00
Author
Owner
Copy Link

comment:5 Changed 4 years ago by lazygravy

I do have it working with the debian files, which is nice. I think that would also be a good!

[comment:5](https://trac.i2p2.de/\#comment:5) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-01-23T02%3A38%3A33Z&precision=second "See timeline at Jan 23, 2017 2:38:33 AM") by lazygravy I do have it working with the debian files, which is nice. I think that would also be a good!
idk commented 2025-04-21 15:11:18 -04:00
Author
Owner
Copy Link

comment:4 Changed 4 years ago by lazygravy

I finally for izback to make a .desktop file, and it turns out that Debian does not like it. :(

Specifically, it generates the "Exec=…" line with the command $INSTALL_DIR/i2prouter.sh start with quotes, which Debian won't run.

What are the disadvantages of using a .desktop file that is written and $INSTALL_DIR is swapped out by izpack?

[comment:4](https://trac.i2p2.de/\#comment:4) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-01-21T18%3A39%3A21Z&precision=second "See timeline at Jan 21, 2017 6:39:21 PM") by lazygravy I finally for izback to make a .desktop file, and it turns out that Debian does not like it. :( Specifically, it generates the "Exec=…" line with the command $INSTALL\_DIR/i2prouter.sh start with quotes, which Debian won't run. What are the disadvantages of using a .desktop file that is written and $INSTALL\_DIR is swapped out by izpack?
idk commented 2025-04-21 15:11:18 -04:00
Author
Owner
Copy Link

comment:3 Changed 4 years ago by zzz

Hopefully the above does not require izpack 5. See #1864

[comment:3](https://trac.i2p2.de/\#comment:3) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-01-15T16%3A48%3A16Z&precision=second "See timeline at Jan 15, 2017 4:48:16 PM") by zzz Hopefully the above does not require izpack 5. See [#1864](https://trac.i2p2.de//ticket/1864 "#1864: defect: IzPack 5 (closed: fixed)")
idk commented 2025-04-21 15:11:19 -04:00
Author
Owner
Copy Link

comment:2 Changed 4 years ago by zzz

Component:router/general →
installerStatus:new →
open

There's an easier way. Izpack does most of the work for us. We currently only enable it for Windows but we can add unix. Docs: ​https://izpack.atlassian.net/wiki/display/IZPACK/Shortcut+Panel

In installer/install.xml in the panels section, add

        <panel classname="ShortcutPanel"><os family="unix" /></panel>

that got me to these errors when running the installer:

/tmp/i2p283foo/Start-I2P-(no-window)-1484487593508.desktop (No such file or directory)
/tmp/i2p283foo/Start-I2P-(restartable)-1484487593510.desktop (No such file or directory)
/tmp/i2p283foo/I2P-router-console-1484487593512.desktop (No such file or directory)

So now take the windows spec file installer/resources/shortcutSpec.xml, copy it to Unix_shortcut_spec.xml, modify as necessary, make sure it's included in build.xml, and add the resources line to install.xml. That part I haven't tried.

[comment:2](https://trac.i2p2.de/\#comment:2) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-01-15T13%3A50%3A24Z&precision=second "See timeline at Jan 15, 2017 1:50:24 PM") by zzz Component:router/general → installerStatus:new → open There's an easier way. Izpack does most of the work for us. We currently only enable it for Windows but we can add unix. Docs: [​https://izpack.atlassian.net/wiki/display/IZPACK/Shortcut+Panel](https://trac.i2p2.de/https://izpack.atlassian.net/wiki/display/IZPACK/Shortcut+Panel) In installer/install.xml in the panels section, add ``` <panel classname="ShortcutPanel"><os family="unix" /></panel> ``` that got me to these errors when running the installer: ``` /tmp/i2p283foo/Start-I2P-(no-window)-1484487593508.desktop (No such file or directory) /tmp/i2p283foo/Start-I2P-(restartable)-1484487593510.desktop (No such file or directory) /tmp/i2p283foo/I2P-router-console-1484487593512.desktop (No such file or directory) ``` So now take the windows spec file installer/resources/shortcutSpec.xml, copy it to Unix\_shortcut\_spec.xml, modify as necessary, make sure it's included in build.xml, and add the resources line to install.xml. That part I haven't tried.
idk commented 2025-04-21 15:11:19 -04:00
Author
Owner
Copy Link

comment:1 Changed 4 years ago by lazygravy

Version:
→ 0.9.28

I have a working copy locally, but I need to make it apart of build.xml.

[comment:1](https://trac.i2p2.de/\#comment:1) Changed [4 years ago](https://trac.i2p2.de//timeline?from=2017-01-14T21%3A01%3A17Z&precision=second "See timeline at Jan 14, 2017 9:01:17 PM") by lazygravy Version: → 0.9.28 I have a working copy locally, but I need to make it apart of build.xml.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
#1026
#1031
#1033
#1036
#1040
#1049
#1051
#1065
#1067
#1076
#1105
#1112
#1139
#1166
#1170
#1172
#1176
#1200
#1222
#1223
#1259
#1263
#1274
#1289
#1302
#1304
#1306
#1308
#1320
#1337
#1338
#1372
#1381
#1384
#1393
#1399
#1410
#1415
#1418
#1438
#1453
#1460
#1479
#1491
#1499
#1519
#1522
#1560
#1564
#1584
#1609
#1613
#1637
#1655
#1657
#1684
#1685
#1689
#1694
#1697
#1716
#1724
#1740
#1742
#1753
#1758
#1766
#1767
#1775
#1802
#1805
#1834
#1837
#1838
#1847
#1848
#1869
#1877
#1893
#1907
#1911
#1915
#1928
#1938
#1951
#1979
#1981
#1982
#1985
#1990
#1999
#2018
#2023
#2024
#2035
#2039
#2056
#2080
#2081
#2083
#2085
#2086
#2088
#2090
#2099
#2100
#2101
#2102
#2106
#2110
#2112
#2114
#2121
#2142
#2145
#2146
#2147
#2149
#2158
#2160
#2162
#2169
#2173
#2177
#2182
#2193
#2212
#2221
#2230
#2231
#2233
#2238
#2240
#2241
#2244
#2251
#2252
#2255
#2257
#2259
#2261
#2263
#2264
#2265
#2269
#2271
#2274
#2275
#2278
#2281
#2297
#23
#2302
#2303
#2304
#2305
#2306
#2309
#2319
#2323
#2324
#2325
#2336
#2337
#2340
#2341
#2346
#2350
#2363
#2371
#2374
#2375
#2376
#2381
#2386
#2393
#2396
#2402
#2411
#2420
#2421
#2426
#2428
#2429
#2431
#2433
#2434
#2446
#2459
#2467
#2472
#2475
#2496
#2497
#2506
#2509
#2512
#2540
#2562
#2572
#2608
#2609
#2613
#2619
#2620
#2625
#2640
#2641
#2642
#2643
#2646
#2647
#2650
#2653
#2655
#2656
#2658
#2660
#2664
#2670
#2672
#2675
#2680
#2681
#2682
#2689
#2690
#2691
#2695
#2700
#2701
#2703
#2704
#2705
#2707
#2711
#2721
#2729
#2730
#2733
#2734
#2735
#2736
#2737
#2738
#2750
#2751
#2754
#2763
#2764
#2766
#2771
#2772
#2773
#2774
#2775
#2780
#2782
#2792
#2793
#2795
#2796
#2799
#2801
#2802
#2803
#2805
#2807
#371
#374
#375
#376
#377
#378
#380
#381
#383
#384
#385
#386
#392
#44
#532
#629
#662
#666
#689
#691
#698
#699
#719
#725
#730
#731
#738
#745
#752
#774
#816
#818
#82
#829
#847
#857
#888
#933
#961
#971
#977
#981
0.9.18
0.9.20
0.9.21
0.9.23
0.9.24
0.9.25
0.9.27
0.9.28
0.9.29
0.9.30
0.9.31
0.9.32
0.9.33
0.9.35
0.9.36
0.9.37
0.9.38
0.9.39
0.9.42
0.9.43
0.9.45
0.9.46
0.9.47
0.9.48
0.9.49
0.9.50
0.9.9
BOB
I2CP
SAM
addressbook
api
apps
blocker
build
console
critical
crypto
data
debian
defect
docker
duplicate
easy-install bundle
enhancement
eventually
general
i2psnark
i2ptunnel
infrastructure
installer
jetty
maintenance
major
minor
misc
naming
netdb
not a bug
not our bug
package
profiles
research
router
soon
streaming
susidns
susimail
systray
task
tests
transport
trivial
tunnels
unconfirmed
undecided
update
utils
website
wontfix
works-for-me
wrapper
No Label
#1928
0.9.29
installer
Milestone
No items
No Milestone 0.9.29
Projects
Clear projects
No project
Assignees
Clear assignees
echelon idk zzz
No Assignees idk
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: I2P_Developers/i2p.i2p#476
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?