Skip to content
This repository was archived by the owner on Aug 24, 2024. It is now read-only.

Commit 2f1254e

Browse files
committed
docs: Update config examples to v3
1 parent 10c3416 commit 2f1254e

File tree

3 files changed

+38
-35
lines changed

3 files changed

+38
-35
lines changed

docs/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# After-Effects
1+
# Ubuntu Post Installation Script
22

33
An Effortless & Simple post-installation script for Ubuntu, Linux Mint, Elementary OS, Debian and their derivatives.
44

@@ -20,15 +20,15 @@ This script is built for one purpose only. Automating post installation tasks on
2020

2121
### Latest Stable Release (Recommended)
2222

23-
```bash
23+
```console
2424
wget https://github.com/tprasadtp/ubuntu-post-install/releases/latest/download/after-effects -O after-effects
2525
wget https://github.com/tprasadtp/ubuntu-post-install/releases/latest/download/sha256sums.txt -O sha256sums.txt
2626
sha256sum -c sha256sums.txt
2727
```
2828

2929
### Master Branch
3030

31-
```bash
31+
```console
3232
wget https://raw.githubusercontent.com/tprasadtp/ubuntu-post-install/master/after-effects -O after-effects
3333
```
3434

docs/tasks.md

+10-18
Original file line numberDiff line numberDiff line change
@@ -140,24 +140,21 @@ purged from the system. This only applies if purge flag is set and purge task is
140140

141141
This will install deb files specified in the YAML config under `config.install.debs`.
142142

143-
- Each entry is URL to the deb file. URL MUST be `http` or `https`, ftp UTLs are not supported!
143+
- Each entry is URL to the deb file. URL MUST be `http` or `https`, ftp URLs are not supported!
144144

145145
```yaml
146146
api: 3
147147
config:
148148
install:
149149
debs:
150-
- https://atom-installer.github.com/v1.21.1/atom-amd64.deb,ATOM-Editor.deb
151-
150+
- https://atom-installer.github.com/v1.21.1/atom-amd64.deb
152151
```
153152

154-
- First part is the URL to the deb file separated by `,` name of the file.
155-
156153
## Install Static binaries to /usr/local/bin
157154

158155
This will install binaries in YAML config under `config.install.binaries`.
159156

160-
- **Simulate** option **will** download the package but not install it.
157+
- **Simulate** option **will** download the binary but not install it.
161158
- Configuration is of format `binary-name::URL`. Binary name **MUST** mach regex `^([a-zA-z0-9_-]+)$`.
162159
- For example, to install `kubectl`, the entry should look like below.
163160

@@ -170,16 +167,11 @@ config:
170167
171168
```
172169

173-
!!! note "Note on file names in configuration"
174-
Please note that file will be saved with the name mentioned in the file and will be in your path.
175-
176170
## Purge Unwanted Packages
177171

178172
This will purge Unwanted packages from the system.
179173

180-
- The packages mentioned in `config.purge` in yaml.
181-
- The format is similar to that of packages, one package per line
182-
174+
- The packages mentioned in list `config.purge` in yaml.
183175
!!! warning
184176
It is necessary to pass command line argument `-d` or set `config.flags.purge_enabled: true` in config.
185177

@@ -245,22 +237,22 @@ config:
245237

246238
| Name | Key |
247239
| ------------------------------------------------------------------------------------------ | ------------- |
248-
| [Add Repositories](#add-repositories) | `repo` |
240+
| Update APT Metadata(Same as running `apt-get update`) | `update` |
241+
| Upgrade packages | `upgrade` |
242+
| [Add Repositories](#add-repositories) | `add_repo` |
249243
| [Add personal package archives (PPA)](#add-personal-package-archives-ppa) | `ppa` |
250244
| [Install apt packages](#install-apt-packages) | `apt` |
251-
| [Install Debian package archives (.deb files)](#install-debian-package-archives-deb-files) | `dev` |
245+
| [Install Debian package archives (.deb files)](#install-debian-package-archives-deb-files) | `debs` |
252246
| [Install Static binaries to /usr/local/bin](#install-static-binaries-to-usrlocalbin) | `binaries` |
253247
| [Purge Unwanted Packages](#purge-unwanted-packages) | `purge` |
254248
| [Installing Snap packages](#installing-snap-packages) | `snaps` |
255-
| [All In one](#all-in-one) | `all` |
256249

257250
## Delete logs
258251

259252
A log file is generated containing all the output generated by the apt and other commands
260253

261-
- This task will delete the log file `after-effects.log`.
262-
- Log file is located in the directory `logs` in folder which you ran thin script.
263-
- Sometimes errors might not be written to log file but displayed on screen and vice-versa.
254+
- This task will delete the log file `after-effects.log` in logs folder
255+
264256

265257
[Miniconda]: https://www.anaconda.com/blog/rpm-and-debian-repositories-for-miniconda
266258
[Brave Browser]: https://brave.com/linux/

docs/yaml.md

+25-14
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ config:
1515
upgrade: false
1616
# Add Repos
1717
# individual repos flags are mentioned under config.add_repo key
18-
repo: true
18+
add_repo: true
1919
# Add PPAs
2020
ppa: true
2121
# APT Packages
@@ -27,28 +27,40 @@ config:
2727
snaps: true
2828
# Repository Flags
2929
add_repo:
30-
brave_browser: true
3130
azurecli: true
3231
bazel: true
32+
brave_browser: true
3333
chrome: true
3434
docker: true
3535
edge: true
36-
gcsfuse: true
36+
gcsfuse: false
3737
github: true
3838
googlecloud: true
3939
gvisor: true
4040
hashicorp: true
4141
mendeley: false
42+
miniconda: true
43+
neurodebian: true
4244
podman: true
45+
protonvpn: true
4346
ros: true
4447
ros2: true
4548
signal: true
4649
skype: true
4750
spotify: true
51+
slack: true
4852
sublimetext: true
4953
teams: true
54+
vivaldi: true
5055
vscode: true
5156
winehq: true
57+
# Debian
58+
debian_nonfree: true
59+
debian_contrib: true
60+
# Ubuntu
61+
ubuntu_universe: true
62+
ubuntu_multiverse: true
63+
ubuntu_restricted: true
5264

5365
# Flags
5466
flags:
@@ -64,33 +76,31 @@ config:
6476
# PPA List
6577
ppa:
6678
- ppa:yubico/stable
79+
- kicad/kicad-5.1-releases
6780
# Install components
6881
# APT Packages, Python Modules, Debian packages
6982
install:
70-
# Debian packages: .deb files
71-
# CSV format similar to lists
72-
debian_packages:
73-
- https://download.teamviewer.com/download/teamviewer_i386.deb,TeamViewer.deb
83+
# Debian packages: .deb files
84+
debs:
85+
- https://download.teamviewer.com/download/teamviewer_i386.deb
86+
- https://github.com/sharkdp/bat/releases/download/v0.17.1/bat_0.17.1_amd64.deb
7487
# Static Binaries which will be placed in /usr/local/bin
75-
# minikube, docker-compose, etc.
76-
# Follows same pattern as Debian packages
77-
# Name to be saved is second field
88+
# <binary-name-as-available-in-path>::<URL>
7889
binaries:
79-
- https://github.com/kubernetes/minikube/releases/download/v0.28.2/minikube-linux-amd64,minikube
80-
- https://github.com/kubernetes/kompose/releases/download/v1.19.0/kompose-linux-amd64,kompose
90+
- minikube::https://github.com/kubernetes/minikube/releases/download/v0.28.2/minikube-linux-amd64
91+
- kompose::https://github.com/kubernetes/kompose/releases/download/v1.19.0/kompose-linux-amd64
8192
apt:
8293
# Admin related Stuff
8394
administration:
8495
- dconf-editor
8596
- htop
8697
- apt-xapian-index
87-
- gdebi
8898
- gparted
8999
- synaptic
90100
- bleachbit
91101
# Security Related Stuff
92102
security:
93-
- gufw
103+
- firewalld
94104
# Productivity & Office Tools.
95105
productivity:
96106
- pandoc
@@ -132,6 +142,7 @@ config:
132142
- google-chrome-stable
133143
- spotify-client
134144
- code
145+
- conda
135146
- google-cloud-sdk
136147
- docker-ce
137148
- runsc

0 commit comments

Comments
 (0)