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
{{ message }}
This repository was archived by the owner on Feb 8, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+14-31Lines changed: 14 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,45 +1,25 @@
1
-
# Nudge (macadmin's Slack #nudge)
1
+
# Nudge-Python (macadmin's Slack #nudge)
2
+
Nudge-Python is now considered End Of Life (EOL) as of February 11th, 2021. The last official version is 2.0.1 which enabled Big Sur support through the use of [macadmins/python 3.9.1](https://github.com/macadmins/python)
3
+
4
+
If you are using a fork of Nudge-Python [(a well known one is located here)](https://github.com/LcTrKiD/nudge), support will not be offered unless the developer of the fork decides to continue support.
5
+
6
+
[While Nudge-Python does support Big Sur, it is recommended to use the new version of Nudge, based on SwiftUI 5.2. You can find that project here.](https://github.com/macadmins/nudge)
7
+
8
+
On March 1st, 2021, this project will be marked as archived through GitHub.
2
9
3
10
## Nudge functionality overview
4
11
- Nudge, rather than trying to install updates, merely prompts users to install updates via an approved method (System Preferences, Munki, Jamf, etc.).
5
12
- By default, Nudge will open every 30 minutes, at the 0 and 30 minute mark. This is because of the default launch agent. If you find this behavior too aggressive, please change the launch agent.
6
13
- The timers are for if the user minimizes/hides the window. It will re-load the window into the foreground, taking precedence over any window.
7
-
- If you want a certain number of days between notifications, you can set that using the `days_between_notifications` preference.
8
14
- Read Alan Siu's [Introduction to Nudge](https://www.alansiu.net/2019/12/24/nudge/) blog post for a more in-depth introduction to Nudge.
9
15
10
-
## Embedded Python
11
-
As of v2.0, Nudge now uses its own embedded python (currently v3.8). This is due to Apple's upcoming removal of Python2.
16
+
## Macadmins Python
17
+
As of v2.0.1, Nudge now requires [macadmins/python 3.9.1](https://github.com/macadmins/python). 3.9.1 is backwards compatible with 10.9.5 through Big Sur 11.0
12
18
13
19
Gurl has been updated from the Munki 4.0 release.
14
20
15
21
Nibbler has been updated to support python 3.
16
22
17
-
### Building embedded python framework
18
-
19
-
To reduce the size of the git repository, you **must** create your own Python. To do this, simply run the `./build_python_framework` script within the repository.
Customized, relocatable framework is at /Library/nudge/Python.framework
39
-
Moving Python.framework to nudge munki-pkg payload folder
40
-
Taking ownership of the file to not break git
41
-
```
42
-
43
23
## Important Information
44
24
You most certainly want to customize the following values:
45
25
@@ -57,6 +37,8 @@ Also, you will at the very least want to change the `company_logo.png`
57
37
## Building this package
58
38
You will need to use [munki-pkg](https://github.com/munki/munki-pkg) to build this package.
59
39
40
+
** This is not to be confused with [munki](https://github.com/munki/munki).** Munki-Pkg is a standalone project that works with all macOS tooling and MDMs
41
+
60
42
## Credits
61
43
This tool would not be possible without [nibbler](https://github.com/pudquick/nibbler), written by [Michael Lynn](https://twitter.com/mikeymikey).
62
44
@@ -75,10 +57,11 @@ The following operating system and versions have been tested.
75
57
- 10.14 -> 10.14.6
76
58
- 10.15 -> 10.15.1
77
59
78
-
## OS Support v2 (embedded python)
60
+
## OS Support v2 (macadmins python)
79
61
The following operating system and versions have been tested with the embedded python.
80
62
- 10.14
81
63
- 10.15
64
+
- 11
82
65
83
66
## Configuration File
84
67
Essentially every component of the UI is customizable, all through a JSON configuration file. An [example file](/example_config.json) is available within the code repository.
0 commit comments