diff options
| author | Christian Cleberg <hello@cleberg.net> | 2024-01-08 20:11:17 -0600 |
|---|---|---|
| committer | Christian Cleberg <hello@cleberg.net> | 2024-01-08 20:11:17 -0600 |
| commit | 25945b8fead989cca09a23983623b63ce36dcc0c (patch) | |
| tree | 0dfc869ce8b028e04ce9da196af08779780915ce | |
| parent | 22b526be60bf4257c2a1d58a5fad59cf6b044375 (diff) | |
| download | cleberg.net-25945b8fead989cca09a23983623b63ce36dcc0c.tar.gz cleberg.net-25945b8fead989cca09a23983623b63ce36dcc0c.tar.bz2 cleberg.net-25945b8fead989cca09a23983623b63ce36dcc0c.zip | |
feat: total re-write from Emacs org-mode to Zola markdown
169 files changed, 11922 insertions, 12556 deletions
@@ -1,2 +1,3 @@ public/ -sitemap.org +static/syntax* +.DS_Store diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d6be27 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# cleberg.net + +## Overview + +This website & blog uses Markdown and [Zola](https://www.getzola.org/). + +## Configuration + +If you want to replicate this project structure, you'll need to customize your +=.emacs= file appropriately, or load a custom =.el= file. + +If you're within emacs while changing =.emacs=, you'll need to reload the +configuration with =M-x load-file= and hit enter to reload the current file +(=.emacs=). + +See the [[./elisp/publish.el][publish.el]] file for this repository's +configuration. + +* Building + +Local testing: + +```sh +zola serve +``` + +Building: + +```sh +zola build +``` + +If you want to build locally and push remotely, you can include `zola build` +in your CI\CD pipeline, or simply use `scp` after building. + +```sh +scp -r public/* user@remote_host:/var/www/your_website/ +``` diff --git a/README.org b/README.org deleted file mode 100644 index 821fa00..0000000 --- a/README.org +++ /dev/null @@ -1,35 +0,0 @@ -#+title: README - -* Overview - -This project uses [[https://orgmode.org/][org-mode]] to structure all documents, including the index page -and sub-pages such as blog posts. - -* Configuration - -If you want to replicate this project structure, you'll need to customize your -=.emacs= file appropriately, or load a custom =.el= file. - -If you're within emacs while changing =.emacs=, you'll need to reload the -configuration with =M-x load-file= and hit enter to reload the current file -(=.emacs=). - -See the [[./elisp/publish.el][publish.el]] file for this repository's -configuration. - -* Building - -When ready to publish, open any of the =.org= files in the project and execute -=M-x org-publish-current-project=. - -If you want to force emacs to re-publish all files, including files without -changes, execute =C-u M-x org-publish-current-project=. - -The resulting files will be published to the =public/= directory within the -repository, which is ignored via the =.gitignore= file. If you wish to publish -the files remotely, you can change the =:publishing-directory= variable in -=publish.el= or do a sync step outside of emacs: - -#+begin_src sh -scp -r public/* ubuntu:/var/www/cleberg.net/ -#+end_src diff --git a/blog/2018-11-28-cpp-compiler.org b/blog/2018-11-28-cpp-compiler.org deleted file mode 100644 index 2f4a8fb..0000000 --- a/blog/2018-11-28-cpp-compiler.org +++ /dev/null @@ -1,127 +0,0 @@ -#+date:2018-11-28 -#+title: The C++ Compiler - -* A Brief Introduction - -[[https://en.wikipedia.org/wiki/C%2B%2B][C++]] is a general-purpose programming language with object-oriented, generic, and -functional features in addition to facilities for low-level memory manipulation. - -The source code, shown in the snippet below, must be compiled before it can be -executed. There are many steps and intricacies to the compilation process, and -this post was a personal exercise to learn and remember as much information as I -can. - -#+BEGIN_SRC cpp -#include <iostream> - -int main() -{ - std::cout << "Hello, world!\n"; -} -#+END_SRC - -* Compilation Process - -** An Overview - -Compiling C++ projects is a frustrating task most days. Seemingly nonexistent -errors keeping your program from successfully compiling can be annoying -(especially since you know you wrote it perfectly the first time, right?). - -I'm learning more and more about C++ these days and decided to write this -concept down so that I can cement it even further in my own head. However, C++ -is not the only compiled language. Check out [[https://en.wikipedia.org/wiki/Compiled_language][the Wikipedia entry for compiled -languages]] for more examples of compiled languages. - -I'll start with a wonderful, graphical way to conceptualize the C++ compiler. -View [[https://web.archive.org/web/20190419035048/http://faculty.cs.niu.edu/~mcmahon/CS241/Notes/compile.html][The C++ Compilation Process]] by Kurt MacMahon, an NIU professor, to see the -graphic and an explanation. The goal of the compilation process is to take the -C++ code and produce a shared library, dynamic library, or an executable file. - -** Compilation Phases - -Let's break down the compilation process. There are four major steps to -compiling C++ code. - -*** Step 1 - -The first step is to expand the source code file to meet all dependencies. The -C++ preprocessor includes the code from all the header files, such as -=#include <iostream>=. Now, what does that mean? The previous example includes -the =iostream= header. This tells the computer that you want to use the -=iostream= standard library, which contains classes and functions written in the -core language. This specific header allows you to manipulate input/output -streams. After all this, you'll end up which a temporary file that contains the -expanded source code. - -In the example of the C++ code above, the =iostream= class would be included -in the expanded code. - -*** Step 2 - -After the code is expanded, the compiler comes into play. The compiler takes the -C++ code and converts this code into the assembly language, understood by the -platform. You can see this in action if you head over to the [[https://godbolt.org][GodBolt Compiler -Explorer]], which shows C++ being converted into assembly dynamically. - -For example, the =Hello, world!= code snippet above compiles into the following -assembly code: - -#+BEGIN_SRC asm -.LC0: - .string "Hello, world!\n" -main: - push rbp - mov rbp, rsp - mov esi, OFFSET FLAT:.LC0 - mov edi, OFFSET FLAT:_ZSt4cout - call std::basic_ostream<char, std::char_traits<char> >& std::operator<< <std::char_traits<char> >(std::basic_ostream<char, std::char_traits<char> >&, char const*) - mov eax, 0 - pop rbp - ret -__static_initialization_and_destruction_0(int, int): - push rbp - mov rbp, rsp - sub rsp, 16 - mov DWORD PTR [rbp-4], edi - mov DWORD PTR [rbp-8], esi - cmp DWORD PTR [rbp-4], 1 - jne .L5 - cmp DWORD PTR [rbp-8], 65535 - jne .L5 - mov edi, OFFSET FLAT:_ZStL8__ioinit - call std::ios_base::Init::Init() [complete object constructor] - mov edx, OFFSET FLAT:__dso_handle - mov esi, OFFSET FLAT:_ZStL8__ioinit - mov edi, OFFSET FLAT:_ZNSt8ios_base4InitD1Ev - call __cxa_atexit -.L5: - nop - leave - ret -_GLOBAL__sub_I_main: - push rbp - mov rbp, rsp - mov esi, 65535 - mov edi, 1 - call __static_initialization_and_destruction_0(int, int) - pop rbp - ret -#+END_SRC - -*** Step 3 - -Third, the assembly code generated by the compiler is assembled into the object -code for the platform. Essentially, this is when the compiler takes the assembly -code and assembles it into machine code in a binary format. After researching -this online, I figured out that a lot of compilers will allow you to stop -compilation at this step. This would be useful for compiling each source code -file separately. This saves time later if a single file changes; only that file -needs to be recompiled. - -*** Step 4 - -Finally, the object code file generated by the assembler is linked together with -the object code files for any library functions used to produce a shared -library, dynamic library, or an executable file. It replaces all references to -undefined symbols with the correct addresses. diff --git a/blog/2018-12-08-aes-encryption.org b/blog/2018-12-08-aes-encryption.org deleted file mode 100644 index 8a33b3a..0000000 --- a/blog/2018-12-08-aes-encryption.org +++ /dev/null @@ -1,103 +0,0 @@ -#+date: 2018-12-08 -#+title: AES Encryption - -* Basic AES - -If you're not familiar with encryption techniques, [[https://en.wikipedia.org/wiki/Advanced_Encryption_Standard][AES]] is the *Advanced -Encryption Standard*. This specification was established by the National -Institute of Standards and Technology, sub-selected from the Rijndael family of -ciphers (128, 192, and 256 bits) in 2001. Furthering its popularity and status, -the US government chose AES as their default encryption method for top-secret -data, removing the previous standard which had been in place since 1977. - -AES has proven to be an extremely safe encryption method, with 7-round and -8-round attacks making no material improvements since the release of this -encryption standard almost two decades ago. - -#+BEGIN_QUOTE -Though many papers have been published on the cryptanalysis of AES, the -fastest single-key attacks on round-reduced AES variants [20, 33] so far are -only slightly more powerful than those proposed 10 years ago [23,24]. -- [[http://research.microsoft.com/en-us/projects/cryptanalysis/aesbc.pdf][Bogdonav, et al.]] -#+END_QUOTE - -* How Secure is AES? - -In theory, AES-256 is non-crackable due to the massive number of combinations -that can be produced. However, AES-128 is no longer recommended as a viable -implementation to protect important data. - -A semi-short [[http://www.moserware.com/2009/09/stick-figure-guide-to-advanced.html][comic strip]] from Moserware quickly explains AES for the public to -understand. Basically AES encrypts the data by obscuring the relationship -between the data and the encrypted data. Additionally, this method spreads the -message out. Lastly, the key produced by AES is the secret to decrypting -it. Someone may know the method of AES, but without the key, they are powerless. - -To obscure and spread the data out, AES creates a substitution-permutation -network. Wikipedia has a wonderful [[https://upload.wikimedia.org/wikipedia/commons/thumb/c/cd/SubstitutionPermutationNetwork2.png/468px-SubstitutionPermutationNetwork2.png][example of an SP network]] available. This -network sends the data through a set of S boxes (using the unique key) to -substitute the bits with another block of bits. Then, a P box will permutate, or -rearrange, the bits. This is done over and over, with the key being derived from -the last round. For AES, the key size specifies the number of transformation -rounds: 10, 12, and 14 rounds for 128-bit, 192-bit, and 256-bit keys, -respectively. - -* The Process - -1. *KeyExpansion=: Using [[https://en.m.wikipedia.org/wiki/Advanced_Encryption_Standard][Rijndael's key schedule]], the keys are dynamically - generated. -2. *AddRoundKey*: Each byte of the data is combined with this key using bitwise - xor. -3. *SubBytes*: This is followed by the substitution of each byte of data. -4. *ShiftRows*: Then, the final three rows are shifted a certain number of - steps, dictated by the cipher. -5. *MixColumns*: After the rows have been shifted, the columns are mixed and - combined. - -This process does not necessarily stop after one full round. Steps 2 through 5 -will repeat for the number of rounds specified by the key. However, the final -round excludes the MixColumns step. As you can see, this is a fairly complex -process. One must have a solid understanding of general mathematic principles to -fully understand how the sequence works (and to even attempt to find a -weakness). - -According to research done by Bogdanov et al., it would take billions of years -to brute force a 126-bit key with current hardware. Additionally, this brute -force attack would require storing 2^88 bits of data! However, there -are a few different attacks that have been used to show vulnerabilities with the -use of this technology. Side-channel attacks use inadvertent leaks of data from -the hardware or software, which can allow attackers to obtain the key or run -programs on a user's hardware. - -Please note that this is not something you should run out and try to implement -in your `Hello, World!` app after only a few hours of research. While AES -(basically all encryption methods) is extremely efficient in what it does, it -takes a lot of time and patience to understand. If you're looking for something -which currently implements AES, check out the [[https://www.bouncycastle.org/documentation.html][Legion of the Bouncy Castle]] for -Java implementations of cryptographic algorithms. - -* Why Does Encryption Matter? - -There are limitless reasons to enable encryption at-rest or in-transit for -various aspects of your digital life. You can research specific examples, such -as [[https://arstechnica.com/tech-policy/2018/12/australia-passes-new-law-to-thwart-strong-encryption/][Australia passes new law to thwart strong encryption]]. However, I will simply -list a few basic reasons to always enable encryption, where feasible: - -1. Privacy is a human right and is recognized as a national right in some - countries (e.g., [[https://www.law.cornell.edu/wex/fourth_amendment][US Fourth Amendment]]). -2. "Why not?" Encryption rarely affects performance or speed, so there's usually - not a reason to avoid it in the first place. -3. Your digital identity and activity (texts, emails, phone calls, online - accounts, etc.) are extremely valuable and can result in terrible - consequences, such as identity theft, if leaked to other parties. Encrypting - this data prevents such leaks from ruining lives. -4. Wiping or factory-resetting does not actually wipe all data from the storage - device. There are methods to read data from the physical disks/boards inside - devices. -5. Corporations, governments, and other nefarious groups/individuals are - actively looking for ways to collect personal information about anyone they - can. If someone's data is unencrypted, that person may become a target due to - the ease of data collection. - -**Read More:** -- [[http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.197.pdf][Federal Information Processing Standards Publication 197]] diff --git a/blog/2019-01-07-useful-css.org b/blog/2019-01-07-useful-css.org deleted file mode 100644 index 3032b59..0000000 --- a/blog/2019-01-07-useful-css.org +++ /dev/null @@ -1,181 +0,0 @@ -#+date: 2019-01-07 -#+title: Useful CSS Snippets - -* Introduction to CSS - -[[https://en.wikipedia.org/wiki/CSS][CSS]], the language used to markup HTML code and make it "pretty", is one of the -most effective ways to increase the attractiveness of a website. It can also -lead to increased user engagement, retention, and satisfaction. In fact, there -are whole career fields are dedicated to the improvement of user experiences, -known as UI design and UX design. - -Some web developers are used to the common CSS properties, such as element -sizing, fonts, colors, etc., but are not as well versed in less-used properties -and values such as =flexbox=, =clip-path=, and =transform=. This article will -provide some insight into the less-used and unique CSS properties. - -* CSS Variables - -The first topic today is CSS variables. Variables are not often used by smaller -developers. CSS variables allow you to give your website a well-defined -structure, where you can easily reuse CSS properties throughout the project. - -You can use variables to define things, such as color palettes. Then, you can -use these colors for backgrounds anywhere else in the HTML. This could be -extended, where extra variables could be defined for =primary-text=, -=quoted-text=, etc. Variables can also be used to define spacing (e.g. =32px= or -=2rem=), which can then be applied to margins, padding, font sizes, and more. - -For example, here are some variables defined at the root of the website, which -allows for any subsequent CSS rules to use those variables: - -#+BEGIN_SRC css -:root { - --primary-color: black; - --secondary-color: white; -} - -body { - background-color: var(--primary-color); - color: var(--secondary-color); -} -#+END_SRC - -* CSS Box Shadows - -Box shadows were once my mortal enemy. No matter how hard I tried, I just -couldn't get them to work how I wanted. Because of this, my favorite discovery -has been CSSMatic's [[https://www.cssmatic.com/box-shadow][box shadow generator]]. It provides an excellent tool to -generate box shadows using their simple sliders. Surprisingly, this is the -reason I learned how box shadows work! You can use the sliders and watch how the -CSS code changes in the image that is displayed. Through this, you should -understand that the basic structure for box shadows is: - -#+BEGIN_SRC css -box-shadow: inset horizontal vertical blur spread color; -#+END_SRC - -Now, let's look at some basic examples! You can copy and paste the following -code into a site like CodePen or your own HTML files. Feel free to play around -with the code, experiment, and learn. - -**Box Shadow #1** - -#+BEGIN_SRC html -<div class="shadow-examples"> - <div class="box effect1"> - <h3>Effect 1</h3> - </div> -</div> -#+END_SRC - -#+BEGIN_SRC css -.box h3 { - text-align: center; - position: relative; - top: 80px; -} -.box { - width: 70%; - height: 200px; - background: #fff; - margin: 40px auto; -} -.effect1 { - box-shadow: 0 10px 6px -6px #777; -} -#+END_SRC - -**Box Shadow #2** - -#+BEGIN_SRC html -<div class="shadow-examples"> - <div class="box effect2"> - <h3>Effect 2</h3> - </div> -</div> -#+END_SRC - -#+BEGIN_SRC css -.box h3 { - text-align: center; - position: relative; - top: 80px; -} -.box { - width: 70%; - height: 200px; - background: #fff; - margin: 40px auto; -} -.effect2 { - box-shadow: 10px 10px 5px -5px rgba(0, 0, 0, 0.75); -} -#+END_SRC - -Try these box shadows out on your own and see how changing each shadow value -works. - -* CSS Flexbox - -Now, let's move on to the best part of this article: flexbox. The flexbox is by -far my favorite new toy. I originally stumbled across this solution after -looking for more efficient ways of centering content horizontally AND -vertically. I had used a few hack-ish methods before, but flexbox throws those -out the window. The best part of it all is that flexbox is /dead simple/. - -Flexbox pertains to the parent div of any element. You want the parent to be the -flexbox in which items are arranged to use the flex methods. It's easier to see -this in action that explained, so let's see an example. - -**Flexbox** - -#+BEGIN_SRC html -<div class="flex-examples"> - <div class="sm-box"> - <h3>1</h3> - </div> - <div class="sm-box"> - <h3>2</h3> - </div> -</div> -#+END_SRC - -#+BEGIN_SRC css -.flex-examples { - display: flex; - flex-wrap: wrap; - justify-content: flex-start; - align-items: center; - padding: 10px; - background-color: #f2f2f2; -} -.sm-box { - display: flex; - justify-content: center; - align-items: center; - width: 20%; - height: 100px; - background: #fff; - margin: 40px 10px; -} -#+END_SRC - -You may notice that we no longer need to use the =top= property for the =h3= -elements in our code. This is because we set the display box to be a flex -container for the small boxes, AND we made the small boxes flex containers for -their elements (the h3 tags). Flex boxes can be nested like this to center -content that is inside centered content. - -For the example above, we designated the =justify-content= property to be -=flex-start= so that the boxes stack from the left side of the screen. This -property can be changed to =center= to make the boxes appear in the center of -the screen. - -For an interactive example, [[https://codepen.io/LandonSchropp/pen/KpzzGo][check out this CodePen]] from [[https://codepen.io/LandonSchropp/][LandonScropp]]. Resize the -window with dice to see how they collapse and re-align. - -* Even More CSS - -For more inspiration, you can visit [[https://www.codepen.io][CodePen]], [[https://dribbble.com][Dribbble]], or [[https://uimovement.com][UI Movement]] to browse -the collections of many amazing web designers. diff --git a/blog/2019-09-09-audit-analytics.org b/blog/2019-09-09-audit-analytics.org deleted file mode 100644 index 702bf8a..0000000 --- a/blog/2019-09-09-audit-analytics.org +++ /dev/null @@ -1,213 +0,0 @@ -#+date: 2019-09-09 -#+title: Data Analysis in Auditing - -* What Are Data Analytics? - -A quick aside before I dive into this post: `data analytics` is a vague term -that has become popular in recent years. Think of a `data analytic` as the -output of any data analysis you perform. For example, a pivot table or a pie -chart could be a data analytic. - -[[https://en.wikipedia.org/wiki/Data_analysis][Data analysis]] is a process that utilizes statistics and other mathematical -methods to discover useful information within datasets. This involves examining, -cleaning, transforming, and modeling data so that you can use the data to -support an opinion, create more useful viewpoints, and gain knowledge to -implement into audit planning or risk assessments. - -One of the common mistakes that managers (and anyone new to the process) make is -assuming that everything involved with this process is "data analytics". In -fact, data analytics are only a small part of the process. - -See *Figure 1* for a more accurate representation of where data analysis sits -within the full process. This means that data analysis does not include -querying or extracting data, selecting samples, or performing audit tests. -These steps can be necessary for an audit (and may even be performed by the same -associates), but they are not data analytics. - -#+CAPTION: The Intelligence Cycle -[[https://img.cleberg.net/blog/20190909-data-analysis-in-auditing/intelligence_cycle-min.png]] - -* Current Use of Analytics in Auditing - -While data analysis has been an integral part of most businesses and departments -for the better part of the last century, only recently have internal audit -functions been adopting this practice. The internal audit function works -exclusively to provide assurance and consulting services to the business areas -within the firm (except for internal auditing firms who are hired by different -companies to perform their roles). - -#+BEGIN_QUOTE -Internal Auditing helps an organization accomplish its objectives by bringing -a systematic, disciplined approach to evaluate and improve the effectiveness -of risk management, control and governance processes. - -- The IIA's Definition of Internal Audit -#+END_QUOTE - -Part of the blame for the slow adoption of data analysis can be attributed to -the fact that internal auditing is strongly based on tradition and following the -precedents set by previous auditors. However, there can be no progress without -auditors who are willing to break the mold and test new audit techniques. In -fact, as of 2018, [[https://www.cpapracticeadvisor.com/accounting-audit/news/12404086/internal-audit-groups-are-lagging-in-data-analytics][only 63% of internal audit departments currently utilize data -analytics]] in North America. This number should be as close as possible to -100%. I have never been part of an audit that would not have benefited from data -analytics. - -So, how do internal audit functions remedy this situation? It's definitely not -as easy as walking into work on Monday and telling your Chief Audit Executive -that you're going to start implementing analytics in the next audit. You need a -plan and a system to make the analysis process as effective as possible. - -* The DELTA Model - -One of the easiest ways to experiment with data analytics and gain an -understanding of the processes is to implement them within your own department. -But how do we do this if we've never worked with analysis before? One of the -most common places to start is to research some data analysis models currently -available. For this post, we'll take a look at the DELTA model. You can take a -look at **Figure 2** for a quick overview of the model. - -The DELTA model sets a few guidelines for areas wanting to implement data -analytics so that the results can be as comprehensive as possible: - -- *Data*: Must be clean, accessible, and (usually) unique. -- *Enterprise-Wide Focus*: Key data systems and analytical resources must be - available for use (by the Internal Audit Function). -- *Leaders*: Must promote a data analytics approach and show the value of - analytical results. -- *Targets*: Must be set for key areas and risks that the analytics can be - compared against (KPIs). -- *Analysts*: There must be auditors willing and able to perform data analytics - or else the system cannot be sustained. - -#+CAPTION: The Delta Model -[[https://img.cleberg.net/blog/20190909-data-analysis-in-auditing/delta-min.png]] - -* Finding the Proper KPIs - -Once the Internal Audit Function has decided that they want to start using data -analytics internally and have ensured they're properly set up to do so, they -need to figure out what they will be testing against. Key Performance Indicators -(KPIs) are qualitative or quantitative factors that can be evaluated and -assessed to determine if the department is performing well, usually compared to -historical or industry benchmarks. Once KPIs have been agreed upon and set, -auditors can use data analytics to assess and report on these KPIs. This allows -the person performing the analytics the freedom to express opinions on the -results, whereas the results are ambiguous if no KPIs exist. - -It should be noted that tracking KPIs in the department can help ensure you have -a rigorous Quality Assurance and Improvement Program (QAIP) in accordance with -some applicable standards, such as IPPF Standard 1300. - -#+BEING_QUOTE -The chief audit executive must develop and maintain a quality assurance and -improvement program that covers all aspects of the internal audit activity. - -- IPPF Standard 1300 -#+END_QUOTE - -Additionally, IPPF Standard 2060 discusses reporting: - -#+BEGIN_QUOTE -The chief audit executive must report periodically to senior management and the -board on the internal audit activity's purpose, authority, responsibility, and -performance relative to its plan and on its conformance with the Code of Ethics -and the Standards. Reporting must also include significant risk and control -issues, including fraud risks, governance issues, and other matters that require -the attention of senior management and/or the board. - -- IPPF Standard 2060 -#+END_QUOTE - -The hardest part of finding KPIs is to determine which KPIs are appropriate for -your department. Since every department is different and has different goals, -KPIs will vary drastically between companies. To give you an idea of where to -look, here are some ideas I came up with when discussing the topic with a few -colleagues. - -- Efficiency/Budgeting: - - Audit hours to staff utilization ratio (annual hours divided by total annual - work hours). - - Audit hours compared to the number of audits completed. - - Time between audit steps or to complete the whole audit. E.g., time from - fieldwork completion to audit report issuance. -- Reputation: - - The frequency that management has requested the services of the IAF. - - Management, audit committee, or external audit satisfaction survey results. - - Education, experience, certifications, tenure, and training of the auditors - on staff. -- Quality: - - Number and frequency of audit findings. Assign monetary or numerical values, - if possible. - - Percentage of recommendations issued and implemented. -- Planning: - - Percentage or number of key risks audited per year or per audit. - - Proportion of audit universe audited per year. - -* Data Analysis Tools - -Finally, to be able to analyze and report on the data analysis, auditors need to -evaluate the tools at their disposal. There are many options available, but a -few of the most common ones can easily get the job done. For example, almost -every auditor already has access to Microsoft Excel. Excel is more powerful than -most people give it credit for and can accomplish a lot of basic statistics -without much work. If you don't know a lot about statistics but still want to -see some of the more basic results, Excel is a great option. - -To perform more in-depth statistical analysis or to explore large datasets that -Excel cannot handle, auditors will need to explore other options. The big three -that have had a lot of success in recent years are Python, R, and ACL. ACL can -be used as either a graphical tool (point and click) or as a scripting tool, -where the auditor must write the scripts manually. Python and the R-language are -solely scripting languages. - -The general trend in the data analytics environment is that if the tool allows -you to do everything by clicking buttons or dragging elements, you won't be able -to fully utilize the analytics you need. The most robust solutions are created -by those who understand how to write the scripts manually. It should be noted -that as the utility of a tool increases, it usually means that the learning -curve for that tool will also be higher. It will take auditors longer to learn -how to utilize Python, R, or ACL versus learning how to utilize Excel. - -* Visualization - -Once an auditor has finally found the right data, KPIs, and tools, they must -report these results so that actions can be taken. Performing in-depth data -analysis is only useful if the results are understood by the audiences of the -data. The best way to create this understanding is to visualize the results of -the data. Let's take a look at some of the best options to visualize and report -the results you've found. - -Some of the most popular commercial tools for visualization are Microsoft -PowerBI and Tableau Desktop. However, other tools exist such as JMP, Plotly, -Qlikview, Alteryx, or D3. Some require commercial licenses while others are -simply free to use. For corporate data, you may want to make sure that the tool -does not communicate any of the data outside the company (such as cloud -storage). I won't be going into depth on any of these tools since visualization -is largely a subjective and creative experience, but remember to constantly -explore new options as you repeat the process. - -Lastly, let's take a look at an example of data visualization. This example -comes from a [[https://talent.works/2018/03/28/the-science-of-the-job-search-part-iii-61-of-entry-level-jobs-require-3-years-of-experience/][blog post written by Kushal Chakrabarti]] in 2018 about the percent -of entry-level US jobs that require experience. *Figure 3* shows us an -easy-to-digest picture of the data. We can quickly tell that only about 12.5% of -entry-level jobs don't require experience. - -This is the kind of result that easily describes the data for you. However, make -sure to include an explanation of what the results mean. Don't let the reader -assume what the data means, especially if it relates to a complex subject. /Tell -a story/ about the data and why the results matter. For example, *Figure 4* -shows a part of the explanation the author gives to illustrate his point. - -#+CAPTION: Entry-Level Visualization -[[https://img.cleberg.net/blog/20190909-data-analysis-in-auditing/vis_example-min.png]] - -#+CAPTION: Visualization Explanation -[[https://img.cleberg.net/blog/20190909-data-analysis-in-auditing/vis_example_explanation-min.png]] - -* Wrap-Up - -While this is not an all-encompassing program that you can just adopt into your -department, it should be enough to get anyone started on the process of -understanding and implementing data analytics. Always remember to continue -learning and exploring new options as your processes grow and evolve. diff --git a/blog/2019-12-03-the-ansoff-matrix.org b/blog/2019-12-03-the-ansoff-matrix.org deleted file mode 100644 index c791edd..0000000 --- a/blog/2019-12-03-the-ansoff-matrix.org +++ /dev/null @@ -1,135 +0,0 @@ -#+date: 2019-12-03 -#+title: The Ansoff Matrix - -* Overview - -As the world of business evolves, managers must approach business planning and -strategy with a contemporary mindset. According to Dess, McNamara, Eisner, and -Lee, managers must be willing to adapt to the modern business environment by -going beyond "'incremental management', whereby they view their job as making a -series of small, minor changes to improve the efficiency of the firm's -operations"[fn:1]. - -One reason that strategic management is crucial is because most businesses that -fail in the United States each year fail due to a lack of strategic focus or -direction[fn:2]. The rate of failure for businesses with poor strategies shows -that strategic planning and management are crucial to a business's strength and -longevity, injecting the critical factors of growth and direction into a -company's business plan. - -One of the most significant strategic planning and management frameworks that -companies can use is the [[https://en.wikipedia.org/wiki/Ansoff_matrix][Ansoff Matrix]]. While this framework has unique purposes -and use-cases, it can effectively help an organization grow and -compete. Specifically, the Ansoff matrix is one of the most effective frameworks -for companies who want to focus on increasing sales revenue or -profitability[fn:3]. - -This framework uses a two-by-two figure to show the four strategic options for -companies to use in this framework: market penetration, market development, -product development, and diversification (see *Figure 1*). The x-axis of the -matrix focuses on the firm's markets and also determines if the firm is looking -to enter new markets or innovate in its current markets. The y-axis of the -matrix focuses on the firm's products and determines if the firm wants to pursue -strategies around their existing products or explore new products. - -#+CAPTION: The Ansoff Matrix by JaisonAbeySabu, Own work, CC BY-SA 3.0 -[[https://img.cleberg.net/blog/20191203-the-ansoff-matrix/ansoff_matrix-min.png]] - -* Strategic Options - -** Market Penetration - -The most straightforward strategy in the Ansoff matrix is to focus on existing -products in existing markets, also known as market penetration[fn:3]. Companies -such as Coca-Cola have used market penetration successfully by investing a lot -of money to get further value out of their current markets. Coca-Cola does this -by introducing new features such as Christmas-themed bottles, personal names on -the bottles, and other marketing schemes. - -** Market Development - -Market development extends existing products into new markets in an attempt to -increase the number of buyers. One interesting way that Coca-Cola used this -strategy comes from the stigma that Diet Coke is a woman's drink[fn:4]. Coca-Cola -introduced Coca-Cola Zero, which contained the same nutritional content as Diet -Coke, but was packaged in a dark black can to appear more "manly"[fn:4]. - -** Product Development - -Product development uses existing markets to introduce new products so that the -firm can better meet customer needs[fn:4]. The extreme end of diversification is -home to companies such as Johnson & Johnson, a healthcare company that has -developed a business portfolio of more than 60,000 different products[fn:5]. -Johnson & Johnson's dedication to continuous diversification has led them to a -balance sheet rating of "AAA", industry recognition for diversification, and -increases in their investor dividends for 57 consecutive years[fn:6]. - -** Related Diversification - -Diversification, the final strategy of the Ansoff Matrix, is more difficult than -the others since it involves exploring both new markets and new products. -Related diversification is a diversification strategy that closely relates to -the firm's core business. Coca-Cola's best example of related diversification is -its acquisition of Glaceau and Vitamin Water, which expanded their drinking -lines of business[fn:4]. - -** Unrelated Diversification - -Unrelated diversification is a diversification strategy that does not really -relate to the firm's core business but still diversifies their business -portfolio. A good example of this would be a coffee company who has decided to -enter the market for bicycle sales. The main purpose of this strategy is to an -extremely diverse company that will not go bankrupt if one market goes through -difficult times. However, this requires a lot of independent skills and heavy -investments since the company most likely cannot easily transfer knowledge -between the markets they compete in. - -* Requirements for Success - -To use the Ansoff Matrix framework, managers need to formulate corporate goals -and objectives. Without goals and direction, management frameworks do not -present much practical utility. Further, the Ansoff Matrix requires the managers -involved to make tactical decisions and create a path for the company to take -toward their goals. Lastly, both the Ansoff Matrix needs to consider both -internal and external perspectives throughout the strategy formulation process. - -One interesting probability is that companies will be using multiple strategic -planning and management frameworks at the same time. While this may sound like -it could crowd the management process, there are numerous reasons to do so. For -example, the Ansoff Matrix and the Balanced Scorecard are relatively popular, -and they cover entirely different parts of a company's strategy. Using the -results from the Balanced Scorecard could inform a company of the potential -product and market demands, such as from customer or supplier survey results, -to help the company determine which Ansoff Matrix strategy to pursue. -However, a combined approach at this level would require mature frameworks -and focused managers who are able to strategize at a high level. - -Lastly, it should be noted that the author of the Ansoff matrix, Igor Ansoff, -often used the term [[https://en.wikipedia.org/wiki/Analysis_paralysis][paralysis by analysis]] to explain the mistake of companies -who overuse analysis and spend too much time planning. Companies need to -understand the utility of a strategic management framework while ensuring that -the company is poised to execute as efficiently as they have planned. - -* Footnotes - -[fn:1]: Dess, G. G., McNamara, G., Eisner, A. B., Lee, S. H. (2019). Strategic -management: Text & cases, ninth edition. New York, NY: McGraw-Hill Education. - -[fn:2]: Juneja, P. (n.d.). Benefits of strategic management. Management Study -Guide. Retrieved from -https://www.managementstudyguide.com/strategic-management-benefits.htm. - -[fn:3]: Meldrum M., McDonald M. (1995) The Ansoff matrix. In: Key Marketing -Concepts. London: Palgrave. - -[fn:4]: Oakley, T. (2015). Coca-Cola: The Ansoff matrix. The Marketing Agenda. -Retrieved from -https://themarketingagenda.com/2015/03/28/coca-cola-ansoff-matrix/. - -[fn:5]: Lemke, T. (2019). The most diversified companies in the stock market. The -balance. Retrieved from -https://www.thebalance.com/the-most-diversified-companies-in-the-stock-market-4169730. - -[fn:6]: Johnson & Johnson. (2018). 2018 Investor Fact Sheet. [PDF file]. Retrieved -from -http://www.investor.jnj.com/\_document/2018-investor-fact-sheet-4-19'id=0000016a-5681-d475-a17f-d78db54a0000. diff --git a/blog/2019-12-16-password-security.org b/blog/2019-12-16-password-security.org deleted file mode 100644 index 2b1712c..0000000 --- a/blog/2019-12-16-password-security.org +++ /dev/null @@ -1,107 +0,0 @@ -#+date: 2019-12-16 -#+title: Password Security - -* Users - -** Why Does It Matter? - -Information security, including passwords and identities, has become one of the -most important digital highlights of the last decade. With [[https://www.usatoday.com/story/money/2018/12/28/data-breaches-2018-billions-hit-growing-number-cyberattacks/2413411002/][billions of people -affected by data breaches each year]], there's a greater need to introduce strong -information security systems. If you think you've been part of a breach, or you -want to check and see, you can use [[https://haveibeenpwned.com/][Have I Been Pwned]] to see if your email has -been involved in any public breaches. Remember that there's a possibility that a -company experienced a breach and did not report it to anyone. - -** How Do I Protect Myself? - -The first place to start with any personal security check-up is to gather a list -of all the different websites, apps, or programs that require you to have login -credentials. Optionally, once you know where your information is being stored, -you can sort the list from the most-important items such as banks or government -logins to less important items such as your favorite meme site. You will want to -ensure that your critical logins are secure before getting to the others. - -Once you think you have a good idea of all your different authentication -methods, I recommend using a password manager such as [[https://bitwarden.com/][Bitwarden]]. Using a -password manager allows you to automatically save your logins, create randomized -passwords, and transfer passwords across devices. However, you'll need to -memorize your "vault password" that allows you to open the password manager. -It's important to make this something hard to guess since it would allow anyone -who has it to access every password you've stored in there. - -Personally, I recommend using a [[https://en.wikipedia.org/wiki/Passphrase][passphrase]] instead of a [[https://en.wikipedia.org/wiki/Password][password]] for your vault -password. Instead of using a string of characters (whether random or simple), -use a phrase and add in symbols and a number. For example, your vault password -could be =Racing-Alphabet-Gourd-Parrot3=. Swap the symbols out for whichever -symbol you want, move the number around, and fine-tune the passphrase until you -are confident that you can remember it whenever necessary. - -Once you've stored your passwords, make sure you continually check up on your -account and make sure you aren't following bad password practices. Krebs on -Security has a great [[https://krebsonsecurity.com/password-dos-and-donts/][blog post on password recommendations]]. Any time that a data -breach happens, make sure you check to see if you were included, and if you need -to reset any account passwords. - -* Developers - -** What Are the Basic Requirements? - -When developing any password-protected application, there are a few basic rules -that anyone should follow even if they do not follow any official guidelines -such as NIST. The foremost practice is to require users to use passwords that -are at least 8 characters and cannot easily be guessed. This sounds extremely -simple, but it requires quite a few different strategies. First, the application -should check the potential passwords against a dictionary of insecure passwords -such =password=, =1234abc=, or =application_name=. - -Next, the application should offer guidance on the strength of passwords being -entered during enrollment. Further, NIST officially recommends *not* -implementing any composition rules that make passwords hard to remember (e.g. -passwords with letters, numbers, and special characters) and instead encouraging -the use of long pass phrases which can include spaces. It should be noted that -to be able to keep spaces within passwords, all unicode characters should be -supported, and passwords should not be truncated. - -** What Does NIST Recommend? - -The National Institute of Standards and Technology ([[https://www.nist.gov][NIST]]) in the US Department -of Commerce regularly publishes information around information security and -digital identity guidelines. Recently, NIST published [[https://pages.nist.gov/800-63-3/sp800-63b.html][Special Publication -800-63b]]: Digital Identity Guidelines and Authentication and Lifecycle -Management. - -#+BEGIN_QUOTE -A Memorized Secret authenticator - commonly referred to as a password or, if -numeric, a PIN - is a secret value intended to be chosen and memorized by the -user. Memorized secrets need to be of sufficient complexity and secrecy that -it would be impractical for an attacker to guess or otherwise discover the -correct secret value. A memorized secret is something you know. - -- NIST Special Publication 800-63B -#+END_QUOTE - -NIST offers a lot of guidance on passwords, but I'm going to highlight just a -few of the important factors: - -- Require passwords to be a minimum of 8 characters (6 characters if randomly - generated and be generated using an approved random bit generator). -- Compare potential passwords against a list that contains values known to be - commonly-used, expected, or compromised. -- Offer guidance on password strength, such as a strength meter. -- Implement a rate-limiting mechanism to limit the number of failed - authentication attempts for each user account. -- Do not require composition rules for passwords and do not require passwords to - be changed periodically (unless compromised). -- Allow pasting of user identification and passwords to facilitate the use of - password managers. -- Allow users to view the password as it is being entered. -- Use secure forms of communication and storage, including salting and hashing - passwords using a one-way key derivation function. - -NIST offers further guidance on other devices that require specific security -policies, querying for passwords, and more. All the information discussed so far -comes from [[https://pages.nist.gov/800-63-3/sp800-63b.html][NIST SP800-63b]] but NIST offers a lot of information on digital -identities, enrollment, identity proofing, authentication, lifecycle management, -federation, and assertions in the total [[https://pages.nist.gov/800-63-3/][NIST SP800-63 Digital Identity -Guidelines]]. diff --git a/blog/2020-01-25-linux-software.org b/blog/2020-01-25-linux-software.org deleted file mode 100644 index b62577b..0000000 --- a/blog/2020-01-25-linux-software.org +++ /dev/null @@ -1,250 +0,0 @@ -#+date: 2020-01-25 -#+title: Linux Software - -* GUI Applications - -** Etcher - -[[https://img.cleberg.net/blog/20200125-the-best-linux-software/etcher.png]] - -[[https://www.balena.io/etcher/][Etcher]] is a quick and easy way to burn ISO images to CDs and USB devices. There -are two different ways you can install this program. First, you can navigate to -the [[https://www.balena.io/etcher/][official website]] and download the AppImage file, which can run without -installation. - -However, AppImage files are not executable by default, so you'll either need to -right-click to open the properties of the file and click the "Allow executing -file as program" box in the Permissions tab or use the following command: - -#+BEGIN_SRC sh -chmod u+x FILE_NAME -#+END_SRC - -If you don't like AppImage files or just prefer repositories, you can use the -following commands to add the author's repository and install it through the -command-line only. - -First, you'll have to echo the repo and write it to a list file: - -#+BEGIN_SRC sh -echo "deb https://deb.etcher.io stable etcher" | sudo tee /etc/apt/sources.list.d/balena-etcher.list -#+END_SRC - -Next, add the application keys to Ubuntu's keyring: - -#+BEGIN_SRC sh -sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 379CE192D401AB61 -#+END_SRC - -Finally, update the repositories and install the app. - -#+BEGIN_SRC sh -sudo apt update && sudo apt install balena-etcher-electron -#+END_SRC - -Using Arch, Manjaro, or another distro using the AUR? Use this command instead: - -#+BEGIN_SRC sh -sudo pacman -S etcher -#+END_SRC - -** Atom - -[[https://img.cleberg.net/blog/20200125-the-best-linux-software/atom.png]] - -[[https://atom.io][Atom]] is the self-proclaimed "hackable text editor for the 21st century". This -text editor is made by GitHub, [[https://news.microsoft.com/2018/06/04/microsoft-to-acquire-github-for-7-5-billion/][now owned by Microsoft]], and has some of the best -add-ons available to customize the layout and abilities of the app. - -First, add the Atom repository to your sources. - -#+BEGIN_SRC sh -sudo add-apt-repository ppa:webupd8team/atom -#+END_SRC - -Next, update your package listings and install atom. - -#+BEGIN_SRC sh -sudo apt update && sudo apt install atom -#+END_SRC - -If you have issues updating your packages with the Atom repository, you'll need -to use the snap package described below instead of the repository. To remove the -repository we just added, use this command: - -#+BEGIN_SRC sh -sudo add-apt-repository -r ppa:webupd8team/atom -#+END_SRC - -You can also install Atom as a snap package, but it must be installed with the -`--classic` flag. A [[https://language-bash.com/blog/how-to-snap-introducing-classic-confinement][full explanation is available]] if you'd like to read more -about why you need the classic flag. - -#+BEGIN_SRC sh -snap install atom --classic -#+END_SRC - -Using Arch, Manjaro, or another distro using the AUR? Use this command instead: - -#+BEGIN_SRC sh -sudo pacman -S atom -#+END_SRC - ---- - -** Visual Studio Code - -[[https://img.cleberg.net/blog/20200125-the-best-linux-software/vscode.png]] - -[[https://code.visualstudio.com][Visual Studio Code]] is yet another fantastic choice for programming on Linux, -especially if you need those extra add-ons to spice up your late-night coding -sessions. The theme used in the screenshot is [[https://marketplace.visualstudio.com/items?itemName=EliverLara.mars][Mars]] by theme creator [[https://github.com/EliverLara][Eliver Lara]], -who makes a ton of great themes for VS Code, Atom, and various Linux desktop -environments. - -To install VS Code, you'll need to download the `.deb` file from the official -website. Once you've downloaded the file, either double-click it to install -through the Software Center or run the following command: - -#+BEGIN_SRC sh -sudo dpkg -i FILE_NAME.deb -#+END_SRC - -You can also install VS Code as a snap package, but it must be installed with -the `--classic` flag. A [[https://language-bash.com/blog/how-to-snap-introducing-classic-confinement][full explanation is available]] if you'd like to read more -about why you need the classic flag. - -#+BEGIN_SRC sh -snap install code --classic -#+END_SRC - -Using Arch, Manjaro, or another distro using the AUR? Use these commands -instead: - -#+BEGIN_SRC sh -sudo pacman -S yay binutils make gcc pkg-config fakeroot yay -S visual-studio-code-bin -#+END_SRC - -** GNOME Tweaks - -[[https://img.cleberg.net/blog/20200125-the-best-linux-software/gnome-tweaks.png]] - -[[https://gitlab.gnome.org/GNOME/gnome-tweaks][Gnome Tweaks]] is the ultimate tool to use if you want to customize your GNOME -desktop environment. This is how you can switch application themes (GTK), shell -themes, icons, fonts, and more. To install GNOME Tweaks on Ubuntu, you just need -to install the official package. - -#+BEGIN_SRC sh -sudo apt install gnome-tweaks -#+END_SRC - -If you've installed Manjaro or Arch with Gnome, you should have the tweak tool -pre-installed. If you're on Fedora, this tool is available as an official -package: - -#+BEGIN_SRC sh -sudo dnf install gnome-tweaks -#+END_SRC - -** Steam - -[[https://img.cleberg.net/blog/20200125-the-best-linux-software/steam.png]] - -[[https://steampowered.com][Steam]] is one of the most popular gaming libraries for computers and is one of -the main reasons that many people have been able to switch to Linux in recent -years, thanks to Steam Proton, which makes it easier to play games not -officially created for Linux platforms. - -To install Steam on Ubuntu, you just need to install the official package. - -#+BEGIN_SRC sh -sudo apt install steam-installer -#+END_SRC - -For Arch-based systems, you'll simply need to install the =steam= package. -However, this requires that you enable the =multilib= source. To do so, use the -following command: - -#+BEGIN_SRC sh -sudo nano /etc/pacman.conf -#+END_SRC - -Now, scroll down and uncomment the =multilib= section. - -#+BEGIN_SRC config -# Before: -#[multilib] -#Include = /etc/pacman.d/mirrorlist - -# After: -[multilib] -Include = /etc/pacman.d/mirrorlist -#+END_SRC - -Finally, install the program: - -#+BEGIN_SRC sh -sudo pacman -S steam -#+END_SRC - -[[./2020-01-26-steam-on-ntfs-drives.html][Problem Launching Steam Games? Click Here.]] - -* Command-Line Packages - -** neofetch - -[[https://img.cleberg.net/blog/20200125-the-best-linux-software/neofetch.png]] - -[[https://github.com/dylanaraps/neofetch][Neofetch]] is a customizable tool used in the command-line to show system -information. This is exceptionally useful if you want to see your system's -information quickly without the clutter of some resource-heavy GUI apps. - -This is an official package if you're running Ubuntu 17.04 or later, so simply -use the following command: - -#+BEGIN_SRC sh -sudo apt install neofetch -#+END_SRC - -If you're running Ubuntu 16.10 or earlier, you'll have to use a series of -commands: - -#+BEGIN_SRC sh -sudo add-apt-repository ppa:dawidd0811/neofetch; sudo apt update; sudo apt install neofetch -#+END_SRC - -Using Arch, Manjaro, or another distro using the AUR? Use this command instead: - -#+BEGIN_SRC sh -sudo pacman -S neofetch -#+END_SRC - -** yt-dlp - -[[https://img.cleberg.net/blog/20200125-the-best-linux-software/yt-dlp.png]] - -[[https://github.com/yt-dlp/yt-dlp][yt-dlp]] is an extremely handy command-line tool that allows you to download video -or audio files from various websites, such as YouTube. There are a ton of -different options when running this package, so be sure to run `yt-dlp --help` -first to look through everything you can do (or give up and search for the best -config online). - -While this shouldn't be a problem for most users, yt-dlp requires Python 2.6, -2.7, or 3.2+ to work correctly, so install Python if you don't have it already. -You can check to see if you have Python installed by running: - -#+BEGIN_SRC sh -python -V -#+END_SRC - -To get the youtube-dl package, simply curl the URL and output the results. - -#+BEGIN_SRC sh -sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp -#+END_SRC - -Finally, make the file executable so that it can be run from the command-line. - -#+BEGIN_SRC sh -sudo chmod a+rx /usr/local/bin/yt-dlp -#+END_SRC diff --git a/blog/2020-01-26-steam-on-ntfs.org b/blog/2020-01-26-steam-on-ntfs.org deleted file mode 100644 index 6f40b99..0000000 --- a/blog/2020-01-26-steam-on-ntfs.org +++ /dev/null @@ -1,88 +0,0 @@ -#+date: 2020-01-26 -#+title: Linux Gaming Tweak: Steam on NTFS Drives - -* Auto-Mount Steam Drives - -[[https://img.cleberg.net/blog/20200125-the-best-linux-software/steam.png]] - -If you want to see how to install Steam on Linux, see my other post: [[./2020-01-25-linux-software.html][Linux Software]]. - -Are you having trouble launching games, even though they've installed correctly? -This may happen if you're storing your games on an NTFS-formatted drive. This -shouldn't be an issue if you're storing your games on the same drive that Steam -is on, but some gamers prefer to put Steam on their main drive and game files on -another SSD or HDD. - -To fix this problem, you'll need to try a few things. First, you'll need to -install the =ntfs-3g= package, which is meant for better interoperability with -Linux. - -#+BEGIN_SRC sh -sudo apt install ntfs-3g -#+END_SRC - -Next, you should set up the =/etc/fstab= file to automatically mount your drives -on boot. To automatically mount your drives when the computer boots up, you'll -have to create the folders you want to mount your drive to first. I store mine -in the =/mnt= folder using names that I'll recognize, but you can create your -folders wherever you want. - -#+BEGIN_SRC sh -mkdir /path/to/folder -#+END_SRC - -For example: - -#+BEGIN_SRC sh -mkdir /mnt/steam_library -#+END_SRC - -To automatically mount drives upon system boot, you will need to collect a few -items. The UUID is the identification number connected to whichever drive you're -using to store Steam games. - -Drives are usually labeled similar to =/dev/nvme0n1p1= or =/dev/sda1=, so you'll -need to find the line in the output of the command below that correlates to your -drive and copy the UUID over to the =/etc/fstab= file. - -#+BEGIN_SRC sh -sudo blkid | grep UUID= -#+END_SRC - -Next, you'll need your =uid= and =gid=. To find these, run the following -command: - -#+BEGIN_SRC sh -id -u && id -g -#+END_SRC - -Now that you have collected the necessary information, open the `/etc/fstab` -file: - -#+BEGIN_SRC sh -sudo nano /etc/fstab -#+END_SRC - -Each drive you want to mount on boot should have its own line in the -=/etc/fstab= file that looks similar to this: - -#+BEGIN_SRC config -UUID=B64E53824E5339F7 /mnt/steam_library ntfs-3g uid=1000,gid=1000 0 0 -#+END_SRC - -Now all you need to do is unmount your drive and re-mount it. You can unmount -the drive by doing this (be sure to use the correct drive name here): - -#+BEGIN_SRC sh -sudo umount /dev/sdxX -#+END_SRC - -You can re-mount all your drives by executing the following: - -#+BEGIN_SRC sh -sudo mount -a -#+END_SRC - -If you don't know what your drive name is, or you're nervous about unmounting -and re-mounting, simply reboot your computer, and it will be done for you -automatically. diff --git a/blog/2020-02-09-cryptography-basics.org b/blog/2020-02-09-cryptography-basics.org deleted file mode 100644 index fc809ca..0000000 --- a/blog/2020-02-09-cryptography-basics.org +++ /dev/null @@ -1,163 +0,0 @@ -#+date: 2020-02-09 -#+title: Cryptography Basics - -* Similar Article Available - -If you haven't already, feel free to read my post on [[./2018-12-08-aes-encryption.html][AES Encryption]]. - -* What is Cryptography? - -In layman's terms, cryptography is a process that can change data from a -readable format into an unreadable format (and vice-versa) through a series of -processes and secrets. More technically, this is the Internet Security -Glossary's definition: - -#+BEGIN_QUOTE -[Cryptography is] the mathematical science that deals with transforming data -to render its meaning unintelligible (i.e., to hide its semantic content), -prevent its undetected alteration, or prevent its unauthorized use. If the -transformation is reversible, cryptography also deals with restoring encrypted -data to an intelligible form. - -- [[https://tools.ietf.org/html/rfc2828][Internet Security Glossary (2000)]] -#+END_QUOTE - -Cryptography cannot offer protection against the loss of data; it simply offers -encryption methods to protect data at-rest and data in-traffic. At a high-level, -encrypted is when plaintext data is encrypted to ciphertext (a secure form of -text that cannot be understood unless decrypted back to plaintext). The -encryption process is completed through the use of a mathematical function that -utilizes one or more values called keys to encrypt or decrypt the data. - -* Key Elements of Cryptographic Systems - -To create or evaluate a cryptographic system, you need to know the essential -pieces to the system: - -- *Encryption Algorithm (Primitive):* A mathematical process that encrypts and - decrypts data. -- *Encryption Key:* A string of bits used within the encryption algorithm as - the secret that allows successful encryption or decryption of data. -- *Key Length (Size):* The maximum number of bits within the encryption key. - It's important to remember that key size is regulated in many countries. -- *Message Digest:* A smaller, fixed-size bit string version of the original - message. This is practically infeasible to reverse, which is why it's commonly - used to verify integrity. - -* Symmetric Systems (Secret Key Cryptography) - -Symmetric cryptography utilizes a secret, bidirectional key to perform both -encryption and decryption of the data. The most common implementation of -symmetric cryptography is the Advanced Encryption Standard, which uses keys that -are 128 bits to 256 bits in size. This standard came after the National -Institute of Standards and Technology (NIST) decided to retire the Data -Encryption Standard (DES) in 2001. - -Since brute force attacks strongly correlate with key length, the 56-bit key -length of DES was considered insecure after it was publicly broken in under 24 -hours. However, there is a modern implementation of DES called Triple DES where -the DES method is applied three times to each data block. - -The main advantages to symmetric systems are the ease of use, since only one key -is required for both encryption and decryption, and the simplicity of the -algorithms. This helps with bulk data encryption that may unnecessarily waste -time and power using asymmetric systems. - -However, symmetric systems have disadvantages to keep in mind. Since the key is -private, it can be difficult to safely distribute keys to communication -partners. Additionally, the key cannot be used to sign messages since it's -necessary to keep the key private. - -* Asymmetric Systems (Public Key Cryptography) - -Asymmetric cryptography utilizes two keys within the system: a secret key that -is privately-held and a public key that can be distributed freely. The -interesting aspect of asymmetric cryptography is that either key can be used to -encrypt the data, there's no rule that dictates which key must be used for -encryption. Once one key is used to encrypt the data, only the other key can be -used to decrypt the data. This means that if the private key encrypts the data, -only the public key can decrypt the data. - -An advantage of this system is that if you successfully decrypt data using one -of the keys, you can be sure of the sender since only the other key could have -encrypted the data. - -One of the major implementations of an asymmetric system is a digital signature. -A digital signature can be generated using the sender's private key, or a -one-way hash function and is used to provide assurance for the integrity and -authenticity of the message. A couple common message digest algorithms are -SHA-256 and SHA-512, which securely compress data and produce a 128-bit message -digest. - -It should be noted that man-in-the-middle attacks are one of the risks with -digital signatures and public keys. To combat this, applications often use a -public key infrastructure (PKI) to independently authenticate the validity of -signatures and keys. - -Due to the large key size and [[https://crypto.stackexchange.com/a/591][inefficient mathematical functions]] of asymmetric -encryption, elliptical curve cryptography (ECC) is often used to increase -security while using fewer resources. - -* Applications of Cryptographic Systems - -There are quite a few implementations of cryptographic systems around the world. -Here are a few popular examples: - -*Transport Layer Security (TLS):* One of the most famous cryptographic -solutions created is TLS, a session-layered or connection-layered internet -protocol that allows for secure communications between browsers and servers. -Using handshakes, peer negotiation, and authentication allows TLS to prevent -eavesdropping and malicious transformation of data. The major reason for TLS -popularity is that a major vulnerability was found in the SSL protocol in 2014. -Instead of SSL, TLS can be used with HTTP to form HTTPS and is the preferred -method for modern web development due to its increased security. - -*Secure Hypertext Transfer Protocol (HTTPS):* An application layer protocol -that allows for secure transport of data between servers and web clients. One of -the unique parts of HTTPS is that it uses a secured port number instead of the -default web port address. - -*Virtual Private Network (VPN):* VPNs are made to securely extend a private -network across public networks by utilizing an encrypted layered tunneling -protocol paired with an authentication method, such as usernames and passwords. -This technology originally allowed remote employees to access their company's -data but have evolved into one of the top choices for anyone who wishes to mask -their sensitive personal data. - -*Internet Protocol Security (IPSec):* This protocol suite facilitates -communication between two or more hosts or subnets by authenticating and -encrypting the data packets. IPSec is used in a lot of VPNs to establish the VPN -connection through the transport and tunnel mode encryption methods. IPSec -encrypts just the data portion of packets in the transport methods, but it -encrypts both the data and headers in the tunnel method (introducing an -additional header for authentication). - -*Secure Shell (SSH):* SSH is another network protocol used to protect network -services by authenticating users through a secure channel. This protocol is -often used for command-line (shell) functions such as remote shell commands, -logins, and file transfers. - -*Kerberos:* Developed by MIT, Kerberos is a computer-network authentication -protocol that works on the basis of tickets to allow nodes communicating over a -non-secure network to prove their identity to one another securely. This is most -commonly used in business environments when used as the authentication and -encryption method for Windows Active Directory (AD). - -* Cybersecurity Controls - -If you're someone who needs solutions on how to control risks associated with -utilizing a crytograhpic system, start with a few basic controls: - -- *Policies:* A policy on the use of cryptographic controls for protection - of information is implemented and is in accordance with organizational - objectives. -- *Key management:* A policy on the use, protection and lifetime of - cryptographic keys is implemented through the entire application lifecycle. -- *Key size:* The organization has researched the optimal key size for their - purposes, considering national laws, required processing power, and - longevity of the solution. -- *Algorithm selection:* Implemented algorithms are sufficiently appropriate - for the business of the organization, robust, and align with recommended - guidelines. -- *Protocol configuration:* Protocols have been reviewed and configured - suitable to the purpose of the business. diff --git a/blog/2020-03-25-session-messenger.org b/blog/2020-03-25-session-messenger.org deleted file mode 100644 index e170727..0000000 --- a/blog/2020-03-25-session-messenger.org +++ /dev/null @@ -1,127 +0,0 @@ -#+date: 2020-03-25 -#+title: Session Private Messenger - -* Privacy Warning - -The company behind Session (Loki Foundation) is from Australia. If you didn't -know, Australia has introduced [[https://parlinfo.aph.gov.au/parlInfo/download/legislation/bills/r6195_aspassed/toc_pdf/18204b01.pdf][legislation]] mandating companies comply with -government requests to build backdoor access into applications. For more -information, read my article on [[./2020-01-25-aes-encryption.html][AES Encryption]]. - -* About Session - -[[https://getsession.org][Session]] is a private, cross-platform messaging app from the [[https://loki.foundation][Loki Foundation]]. As -someone who has spent years looking for quality alternatives to major messaging -apps, I was excited when I first heard about Session. Reading through [[https://arxiv.org/pdf/2002.04609.pdf][Session's -white paper]], you can learn the technologies behind the Session app. Part of the -security of Session comes from the Signal protocol, which was forked as the -origin of Session. - -#+BEGIN_QUOTE -Session is an end-to-end encrypted messenger that removes sensitive metadata -collection, and is designed for people who want privacy and freedom from any -forms of surveillance. -#+END_QUOTE - -In general, this app promises security through end-to-end encryption, -decentralized onion routing, and private identities. The biggest change that the -Loki Foundation has made to the Signal protocol is removing the need for a phone -number. Instead, a random identification string is generated for any session you -create. This means you can create a new session for each device if you want to, -or link new devices with your ID. - -Since Session's website and white paper describe the details of Session's -security, I'm going to focus on using the app in this post. - -* Features - -Since most people are looking for an alternative to a popular chat app, I am -going to list out the features that Session has so that you are able to -determine if the app would suit your needs: - -- Multiple device linking (via QR code or ID) -- App locking via device screen lock, password, or fingerprint -- Screenshot blocking -- Incognito keyboard -- Read receipts and typing indicators -- Mobile notification customization -- Old message deletion and conversation limit -- Backups -- Recovery phrase -- Account deletion, including ID, messages, sessions, and contacts - -* Downloads - -I have tested this app on Ubuntu 19.10, Android 10, macOS Monterey, and iOS 15. -All apps have worked well without many issues. - -Below is a brief overview of the Session app on Linux. To get this app, you'll -need to go to the [[https://getsession.org/download/][Downloads]] page and click to link to the operating system -you're using. - -For Linux, it will download an AppImage that you'll need to enable with the -following command: - -#+BEGIN_SRC sh -sudo chmod u+x session-messenger-desktop-linux-x86_64-1.0.5.AppImage -#+END_SRC - -#+CAPTION: Session Download Options -[[https://img.cleberg.net/blog/20200325-session-private-messenger/session_downloads.png]] - -* Creating an Account - -Once you've installed the app, simply run the app and create your unique Session -ID. It will look something like this: -=05af1835afdd63c947b47705867501d6373f486aa1ae05b1f2f3fcd24570eba608=. - -You'll need to set a display name and, optionally, a password. If you set a -password, you will need to enter it every time you open the app. - -#+CAPTION: Session Login (Linux) -[[https://img.cleberg.net/blog/20200325-session-private-messenger/session_linux_login.png]] - -#+CAPTION: Session Login (macOS) -[[https://img.cleberg.net/blog/20200325-session-private-messenger/session_macos_login.png]] - -#+CAPTION: Password Authentication -[[https://img.cleberg.net/blog/20200325-session-private-messenger/session_password_authentication.png]] - -* Start Messaging - -Once you've created your account and set up your profile details, the next step -is to start messaging other people. To do so, you'll need to share your Session -ID with other people. From this point, it's fairly straightforward and acts like -any other messaging app, so I won't dive into much detail here. - -** macOS - -#+CAPTION: macOS Conversations -[[https://img.cleberg.net/blog/20200325-session-private-messenger/session_macos_conversations.png]] - -One key feature to note is that the desktop application now provides a helpful -pop-up box explaining the process that Session uses to hide your IP address: - -#+CAPTION: IP Address Help Box -[[https://img.cleberg.net/blog/20200325-session-private-messenger/session_ip.png]] - -** iOS - -The mobile app is quite simple and effective, giving you all the standard mobile -messaging options you'd expect. - -#+CAPTION: iOS App -[[https://img.cleberg.net/blog/20200325-session-private-messenger/session_ios.png]] - -* Potential Issues - -I've discovered one annoying issue that would prevent from using this app -regularly. On a mobile device, there have been issues with receiving messages on -time. Even with battery optimization disabled and no network restrictions, -Session notifications sometimes do not display until I open the app or the -conversation itself and wait a few moments. This is actually one of the reasons -I stopped using Signal (this seems fixed as of my updates in 2021/2022, -so I wouldn't worry about this issue anymore). - -Looking for another messenger instead of Session? I recommend Signal, Matrix, -and IRC. diff --git a/blog/2020-05-03-homelab.org b/blog/2020-05-03-homelab.org deleted file mode 100644 index acfe186..0000000 --- a/blog/2020-05-03-homelab.org +++ /dev/null @@ -1,151 +0,0 @@ -#+date: 2020-05-03 -#+title: An Inside Look at My Homelab - -* What is a Homelab? - -Starting as a developer, I have largely stayed away from hardware-based hobbies -(other than building a gaming desktop). However, as the quarantine for COVID-19 -stretches out further and further, I found myself bored and in search of new -hobbies. After spending the last few months browsing the [[https://www.reddit.com/r/homelab/][r/homelab]] subreddit, I -decided it was time to jump in and try things out for myself. - -Since I am a beginner and just recently graduated from college, everything I've -done so far in my homelab is fairly low-budget. - -* Hardware - -#+CAPTION: HomeLab Diagram -[[https://img.cleberg.net/blog/20200503-homelab/homelab-min.png]] - -** Raspberry Pi 4 - -Luckily, I had actually purchased a [[https://www.raspberrypi.org/products/raspberry-pi-4-model-b/][Raspberry Pi 4]] before the quarantine started -so that I could try to keep Plex Media Center running, even while my desktop -computer was turned off. I started here, using the Pi to hold Plex and Pi-hole -until I grew tired with the slow performance. - -Here are the specifications for the Pi 4: - -- Broadcom BCM2711, Quad core Cortex-A72 (ARM v8) 64-bit SoC @ 1.5GHz -- 4GB LPDDR4-3200 SDRAM -- Gigabit Ethernet -- H.265 (4kp60 decode), H264 (1080p60 decode, 1080p30 encode) -- 64 GB MicroSD Card - -** Dell Optiplex 5040 - -Since I wasn't happy with the Pi as my main server, I turned to Craigslist. I -know a lot of other homelabbers use Ebay, but I can't seem to ever trust it -enough to purchase items on there. So I used Craigslist and found a Dell -Optiplex 5040 desktop computer on sale for $90. While this computer might be -underpowered, it was one of the few computers under $100 that was available -during quarantine. - -Here are the specifications for the Dell Optiplex 5040: - -- Intel Core i3 6100 -- 8GB RAM DDR3 -- Intel HD Graphics -- Gigabit Ethernet -- 500GB Hard Drive - -While this hardware would be awful for a work computer or a gaming rig, it -turned out to be wonderful for my server purposes. The only limitation I have -found so far is the CPU. The i3-6100 only has enough power for a single 4k video -transcode at a time. I haven't tested more than three 1080p streams at a time, -but the maximum amount of streams I've ever actually used is two. - -** WD easystore 10TB & 8TB - -Application storage and temporary files are stored on the internal hard drive of -the server, but all media files (movies, tv, games, books, etc) are stored -externally on my WD easystore hard drive. Creating auto-boot configurations in -the =/etc/fstab= file on my server allows the hard drives to automatically mount -whenever I need to restart my server. - -#+BEGIN_QUOTE -Update: In March 2022, I shucked the hard drives out of their external cases, -put some Kapton tape on the third power pin to prevent power shutdowns, and -stuck them inside my server tower using internal SATA cables. -#+END_QUOTE - -** Netgear Unmanaged Switch - -To manage all the ethernet cords used by my homelab, my desktop, and my living -room media center, I purchased an 8-port gigabit ethernet switch for $50 at my -local computer store. This is probably much more than I should have spent on an -unmanaged switch, but I am comfortable with the choice. - -** TP-Link Managed Switch - -Since I use the unmanaged switch to group all living room devices together, I -use the managed switch to configure VLANs and secure my network. - -** Arris TM1602A Modem & Sagecom Fast 5280 Router - -My default modem and router, provided by my ISP, are fairly standard. The Arris -modem supports DOCSIS 3.0, which is something that I definitely wanted as a -minimum. The Sagecom router is also standard, no fancy bells or whistles. -However, it does support DHCP and DHCPv6, which is something you can use to -route all household traffic through a pi-hole or firewall. - -** TP-Link EAP - -In order to gain better control over the network, I use my own wireless access -point instead of the one included in the Sagecom router above. Now I can control -and organize all of my ethernet connections through the VLANs on the managed -switch and wireless connections through the VLANS on the EAP. - -** Generic Printer - -The last piece to my homelab is a standard wireless printer. Nothing special -here. - -* Software - -** Ubuntu Server 20.04 - -While the 20.04 version of Ubuntu was just released, I always like to experiment -with new features (and I don't mind breaking my system - it just gives me more -experience learning how to fix things). So, I have Ubuntu Server 20.04 installed -on the Dell Optiplex server and Ubuntu Server 19.10 installed on the Raspberry -Pi. Once I find an acceptable use for the Pi, I will most likely switch the -operating system. - -** Docker - -I am /very/ new to Docker, but I have had a lot of fun playing with it so far. -Docker is used to create containers that can hold all the contents of a system -without interfering with other software on the same system. So far, I have -successfully installed pi-hole, GitLab, Gogs, and Nextcloud in containers. -However, I opted to delete all of those so that I can reconfigure them more -professionally at a later time. - -** Plex Media Server - -Plex is a media center software that allows you to organize your movies, TV -shows, music, photos, and videos automatically. It will even download metadata -for you so that you can easily browse these collections. - -** Pi-hole - -Pi-hole is an alternative ad-blocker that runs at the DNS level, allowing you to -block traffic when it hits your network, so that you can reject any traffic you -deem to be bad. Pi-hole uses blacklists and whitelists to decide which traffic -block and, luckily, there are a lot of pre-made lists out there on Reddit, -GitHub, etc. - -** Nextcloud - -While I had trouble with the Docker version of Nextcloud, I was very successful -when setting up the snap version. Using this, I was able to map Nextcloud to a -subdomain of a domain I own in Namecheap. Additionally, Nextcloud has an -integration with Let's Encrypt that allows me to issue certificates -automatically to any new domain I authorize. - -** Webmin - -To monitor my servers, and the processes running on them, I use the Webmin -dashboard. This was fairly painless to set up, and I currently access it -straight through the server's IP address. In the future, I will be looking to -configure Webmin to use a custom domain just like Nextcloud. diff --git a/blog/2020-05-19-customizing-ubuntu.org b/blog/2020-05-19-customizing-ubuntu.org deleted file mode 100644 index 2375aac..0000000 --- a/blog/2020-05-19-customizing-ubuntu.org +++ /dev/null @@ -1,185 +0,0 @@ -#+date: 2020-05-19 -#+title: Beginner's Guide: Customizing Ubuntu - -* More Information - -For inspiration on designing your \*nix computer, check out the [[https://libredd.it/r/unixporn][r/unixporn]] -subreddit! - -* Customizing Ubuntu - -New to Linux and want to add a personal touch to your machine? One of the best -perks of Linux is that it is *extremely* customizable. You can change the -styles of the windows, shell (status bars/docks), icons, fonts, terminals, and -more. - -In this post, I'm going to go through customization on Ubuntu 20.04 (GNOME) -since most new users tend to choose Ubuntu-based distros. If you've found a way -to install Arch with i3-gaps, I'm assuming you know how to find more advanced -tutorials out there on customizations. - -** Required Tools - -#+CAPTION: Gnome Tweaks -[[https://img.cleberg.net/blog/20200519-customizing-ubuntu/gnome-tweaks-min.png]] - -Ubuntu 20.04 ships with the default desktop environment [[https://www.gnome.org/][Gnome]], which includes -the handy =gnome-tweaks= tool to quickly change designs. To install this, just -open your terminal and enter the following command: - -#+BEGIN_SRC sh -sudo apt install gnome-tweaks -#+END_SRC - -After you've finished installing the tool, simply launch the Tweaks application, -and you'll be able to access the various customization options available by -default on Ubuntu. You might even like some of the pre-installed options. - -** GNOME Application Themes - -To change the themes applied to applications in GNOME, you will need to change -the Applications dropdown in the Appearance section of Tweaks. To add more -themes, you will have to find your preferred theme online and follow the steps -below to have it show up in the Tweaks tool. While you may find themes anywhere, -one of the most popular sites for GNOME themes is [[https://www.gnome-look.org/][gnome-look.org]]. This website -contains themes for applications, shells, icons, and cursors. - -Steps to import themes into Tweaks: - -1. Download the theme. -2. These files are usually compressed (.zip, .tar.gz, .tar.xz), so you will need - to extract the contents. This is easiest when opening the file explorer, - right-clicking the compressed file, and choosing "Extract here." -3. Move the theme folder to =/usr/share/themes/=. You can do so with the - following command: =sudo mv theme-folder/ /usr/share/themes/=. - - Icons and cursors will be moved to the =/usr/share/icons/= folder. - - Fonts will be moved to the =/usr/share/fonts/= folder Alternatively, you - can move them to the =/usr/share/fonts/opentype/= or - =/usr/share/fonts/opentype/= folders, if you have a specific font type. -4. Close tweaks if it is open. Re-open Tweaks and your new theme will be - available in the Applications dropdown in the Appearance section of Tweaks. - -If the theme is not showing up after you've moved it into the themes folder, you -may have uncompressed the folder into a sub-folder. You can check this by -entering the theme folder and listing the contents: - -#+BEGIN_SRC sh -cd /usr/share/themes/Mojave-Dark && ls -la -#+END_SRC - -This is an example of what the contents of your theme folder should look like. -If you just see another folder there, you should move that folder up into the -=/usr/share/themes/= folder. - -#+BEGIN_SRC sh -cinnamon COPYING gnome-shell gtk-2.0 gtk-3.0 index.theme metacity-1 plank xfwm4 -#+END_SRC - -** GNOME Shell Themes - -To change the appearance of the title bar, default dock, app menu, and other -parts of the GNOME shell, you'll need to install the [[https://extensions.gnome.org/extension/19/user-themes/][user themes]] extension on -[[https://extensions.gnome.org/][Gnome Extensions]]. To be able to install extensions, you will first need to -install the browser extension that the website instructs you to. See this -screenshot for the blue box with a link to the extension. - -#+CAPTION: Gnome Extensions -[[https://img.cleberg.net/blog/20200519-customizing-ubuntu/gnome-extensions-min.png]] - -After the browser extension is installed, you will need to install the native -host connector: - -#+BEGIN_SRC sh -sudo apt install chrome-gnome-shell -#+END_SRC - -Finally, you can go the [[https://extensions.gnome.org/extension/19/user-themes/][user themes]] extension page and click the installation -button. This will enable the Shell option in Tweaks. Now you can move shell -themes to the =/usr/share/themes= directory, using the same steps mentioned in -the previous section, and enable the new theme in Tweaks. - -** Icons & Cursors - -Icons and cursors are installed exactly the same way, so I'm grouping these -together in this post. Both of these items will need to follow the same process -as installing themes, except you will want to move your font folders to the -=/usr/share/icons/= directory instead. - -** Fonts - -Fonts are one of the overlooked parts of customization, but a good font can make -the whole screen look different. For example, I have installed the [[https://github.com/IBM/plex/releases][IBM Plex]] -fonts on my system. This follows the same process as installing themes, except -you will want to move your font folders to the =/usr/share/fonts/= directory -instead. - -** Terminal - -If you spend a lot of time typing commands, you know how important the style and -functionality of the terminal is. After spending a lot of time using the default -GNOME terminal with [[https://en.wikipedia.org/wiki/Bash_(Unix_shell)][unix shell]], I decided to try some different options. I ended -up choosing [[https://terminator-gtk3.readthedocs.io/en/latest/][Terminator]] with [[https://en.wikipedia.org/wiki/Z_shell][zsh]]. - -Terminator is great if you need to open multiple terminals at one time by simply -right-clicking and splitting the screen into as many terminals as you want. -While this project hasn't been updated in a while, [[https://github.com/gnome-terminator/terminator/issues/1][it is coming under new -development]]. However, this terminal is great and I haven't experienced any -errors yet. - -For the shell choice, I decided to choose zsh after trying it out on a fresh -Manjaro installation. Zsh is great if you like to change the themes of your -terminal, include icons, or add plugins. - -The desktop uses the [[https://github.com/zsh-users/zsh-autosuggestions][zsh-autosuggestions]] to suggest past commands as you -type. In addition, it suggests corrections if you misspell a command. Lastly, it -uses the =af-magic= theme, which adds dashed lines between commands, moving the -user@host tag to the right side of the terminal, and changes the colors. There -are plenty of plugins and themes to choose from. Just figure out what you like -and add it to your =~/.zshrc= file! - -*** Steps to Replicate My Terminal - -To install zsh on Ubuntu, enter the following command into a terminal: - -#+BEGIN_SRC sh -sudo apt install zsh -#+END_SRC - -Then, enter the next command to activate zsh: - -#+BEGIN_SRC sh -sudo chsh -s $(which zsh) $(whoami) -#+END_SRC - -To install Terminator on Ubuntu: - -#+BEGIN_SRC sh -sudo apt install terminator -#+END_SRC - -To install Oh My Zsh on Ubuntu: - -#+BEGIN_SRC sh -sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" -#+END_SRC - -To install zsh-autosuggestions via Oh My Zsh: - -#+BEGIN_SRC sh -git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions -#+END_SRC - -Then, add the following plugin wording to your =~/.zshrc= file (the default -config usually has the =git= plugin activated, so just add any other plugins to -the parentheses separated by a space): - -#+BEGIN_SRC sh -nano ~/.zshrc -#+END_SRC - -#+BEGIN_SRC sh -plugins=(git zsh-autosuggestions) -#+END_SRC - -Finally, you need to log out of your computer and log back in so your user shell -can refresh. diff --git a/blog/2020-07-20-video-game-sales.org b/blog/2020-07-20-video-game-sales.org deleted file mode 100644 index 4c5e8f4..0000000 --- a/blog/2020-07-20-video-game-sales.org +++ /dev/null @@ -1,176 +0,0 @@ -#+date: 2020-07-20 -#+title: Data Exploration: Video Game Sales - -* Background Information - -This dataset (obtained from [[https://www.kaggle.com/gregorut/videogamesales/data][Kaggle]]) contains a list of video games with sales -greater than 100,000 copies. It was generated by a scrape of vgchartz.com. - -Fields include: - -- Rank: Ranking of overall sales -- Name: The game name -- Platform: Platform of the game release (i.e. PC,PS4, etc.) -- Year: Year of the game's release -- Genre: Genre of the game -- Publisher: Publisher of the game -- NA_Sales: Sales in North America (in millions) -- EU_Sales: Sales in Europe (in millions) -- JP_Sales: Sales in Japan (in millions) -- Other_Sales: Sales in the rest of the world (in millions) -- Global_Sales: Total worldwide sales. - -There are 16,598 records. 2 records were dropped due to incomplete information. - -* Import the Data - -#+BEGIN_SRC python -# Import the Python libraries we will be using -import pandas as pd -import numpy as np -import seaborn as sns; sns.set() -import matplotlib.pyplot as plt - -# Load the file using the path to the downloaded file -file = r'video_game_sales.csv' -df = pd.read_csv(file) -df -#+END_SRC - -#+CAPTION: Dataframe Results -[[https://img.cleberg.net/blog/20200720-data-exploration-video-game-sales/01_dataframe-min.png]] - -* Explore the Data - -#+BEGIN_SRC python -# With the description function, we can see the basic stats. For example, we can also see that the 'Year' column has some incomplete values. -df.describe() -#+END_SRC - -#+CAPTION: df.describe() -[[https://img.cleberg.net/blog/20200720-data-exploration-video-game-sales/02_describe-min.png]] - -#+BEGIN_SRC python -# This function shows the rows and columns of NaN values. For example, df[179,3] = nan -np.where(pd.isnull(df)) - -(array([179, ..., 16553], dtype=int64), - array([3, ..., 5], dtype=int64)) -#+END_SRC - -* Visualize the Data - -#+BEGIN_SRC python -# This function plots the global sales by platform -sns.catplot(x='Platform', y='Global_Sales', data=df, jitter=False).set_xticklabels(rotation=90) -#+END_SRC - -#+CAPTION: Plot of Global Sales by Platform -[[https://img.cleberg.net/blog/20200720-data-exploration-video-game-sales/03_plot-min.png]] - -#+BEGIN_SRC python -# This function plots the global sales by genre -sns.catplot(x='Genre', y='Global_Sales', data=df, jitter=False).set_xticklabels(rotation=45) -#+END_SRC - -#+CAPTION: Plot of Global Sales by Genre -[[https://img.cleberg.net/blog/20200720-data-exploration-video-game-sales/04_plot-min.png]] - -#+BEGIN_SRC python -# This function plots the global sales by year -sns.lmplot(x='Year', y='Global_Sales', data=df).set_xticklabels(rotation=45) -#+END_SRC - -#+CAPTION: Plot of Global Sales by Year -[[https://img.cleberg.net/blog/20200720-data-exploration-video-game-sales/05_plot-min.png]] - -#+BEGIN_SRC python -# This function plots four different lines to show sales from different regions. -# The global sales plot line is commented-out, but can be included for comparison -df2 = df.groupby('Year').sum() -years = range(1980,2019) - -a = df2['NA_Sales'] -b = df2['EU_Sales'] -c = df2['JP_Sales'] -d = df2['Other_Sales'] -# e = df2['Global_Sales'] - -fig, ax = plt.subplots(figsize=(12,12)) -ax.set_ylabel('Region Sales (in Millions)') -ax.set_xlabel('Year') - -ax.plot(years, a, label='NA_Sales') -ax.plot(years, b, label='EU_Sales') -ax.plot(years, c, label='JP_Sales') -ax.plot(years, d, label='Other_Sales') -# ax.plot(years, e, label='Global_Sales') - -ax.legend() -plt.show() -#+END_SRC - -#+CAPTION: Plot of Regional Sales by Year -[[https://img.cleberg.net/blog/20200720-data-exploration-video-game-sales/06_plot-min.png]] - -* Investigate Outliers - -#+BEGIN_SRC python -# Find the game with the highest sales in North America -df.loc[df['NA_Sales'].idxmax()] - -Rank 1 -Name Wii Sports -Platform Wii -Year 2006 -Genre Sports -Publisher Nintendo -NA_Sales 41.49 -EU_Sales 29.02 -JP_Sales 3.77 -Other_Sales 8.46 -Global_Sales 82.74 -Name: 0, dtype: object - -# Explore statistics in the year 2006 (highest selling year) -df3 = df[(df['Year'] == 2006)] -df3.describe() -#+END_SRC - -#+CAPTION: Descriptive Statistics of 2006 Sales -[[https://img.cleberg.net/blog/20200720-data-exploration-video-game-sales/07_2006_stats-min.png]] - -#+BEGIN_SRC python -# Plot the results of the previous dataframe (games from 2006) - we can see the year's results were largely carried by Wii Sports -sns.catplot(x="Genre", y="Global_Sales", data=df3, jitter=False).set_xticklabels(rotation=45) -#+END_SRC - -#+CAPTION: Plot of 2006 Sales -[[https://img.cleberg.net/blog/20200720-data-exploration-video-game-sales/08_plot-min.png]] - -#+BEGIN_SRC python -# We can see 4 outliers in the graph above, so let's get the top 5 games from that dataframe -# The results below show that Nintendo had all top 5 games (3 on the Wii and 2 on the DS) -df3.sort_values(by=['Global_Sales'], ascending=False).head(5) -#+END_SRC - -#+CAPTION: Outliers of 2006 Sales -[[https://img.cleberg.net/blog/20200720-data-exploration-video-game-sales/09_outliers-min.png]] - -* Discussion - -The purpose of exploring datasets is to ask questions, answer questions, and -discover intelligence that can be used to inform decision-making. So, what have -we found in this dataset? - -Today we simply explored a publicly-available dataset to see what kind of -information it contained. During that exploration, we found that video game -sales peaked in 2006. That peak was largely due to Nintendo, who sold the top 5 -games in 2006 and has a number of games in the top-10 list for the years -1980-2020. Additionally, the top four platforms by global sales (Wii, NES, GB, -DS) are owned by Nintendo. - -We didn't explore everything this dataset has to offer, but we can tell from a -brief analysis that Nintendo seems to rule sales in the video gaming world. -Further analysis could provide insight into which genres, regions, publishers, -or world events are correlated with sales. diff --git a/blog/2020-08-22-redirect-github-pages.org b/blog/2020-08-22-redirect-github-pages.org deleted file mode 100644 index bd86a26..0000000 --- a/blog/2020-08-22-redirect-github-pages.org +++ /dev/null @@ -1,120 +0,0 @@ -#+date: 2020-08-22 -#+title: Redirect GitHub Pages from Subdomain to the Top-Level Domain - -* Short answer - -** Step 1 - -Add a new file CNAME to your GitHub Pages repository containing only one line: -your top-level domain name. E.g.: =example.com= - -** Step 2 - -[Optional] but highly recommended - -2.1: Remove all other top-level records (prefixed with @) of type A from your -DNS configuration. - -2.2: Remove a CNAME record for the second-level domain www if it is present. - -** Step 3 - -Add these 5 entries to the very top of your DNS configuration: - -#+BEGIN_SRC txt -@ A 185.199.108.153 -@ A 185.199.109.153 -@ A 185.199.110.153 -@ A 185.199.111.153 -www CNAME your_github_username.github.io. -#+END_SRC - -Replace =your_github_username= with your actual GitHub username. - -** Step 4 - -Wait for your DNS changes to propagate. DNS changes aren't effective -immediately. They can take up to a full day to propagate. - -* Long answer - -This issue has two sides. One is the DNS configuration itself. Another one is -the way GitHub Pages will forward HTTP requests. - -We need to know a few things to understand what GitHub is trying to say in their -documentation. - -** DNS Entry Types - -There are two types of DNS records which interest us: CNAME and A. - -=A= is also known as =Apex= or sometimes as =root entry=. It forwards requests -to a specified fixed IP address. =CNAME= entry forwards requests to a specified -URL (actual valid plain text URL, not an IP address). - -** DNS Load balancing - -GitHub has one central URL address which accepts all DNS requests for GitHub -Pages: =http://username.github.io=. That URL is resolved to different IP -addresses based on your geographical location. Website hosted on GitHub Pages is -a simple collection of =HTML=, =CSS= and =JS= files. GitHub distributes these -files to different servers across the globe. So that when your browser sends a -request from Europe, it receives data from a server in Europe. The same is valid -for the requests from Asia and the USA. - -** What GitHub is trying to say - -Since =A= records in DNS must contain IP addresses, and they must be either -=185.199.108.153= or =185.199.109.153= or =185.199.110.153= or -=185.199.111.153=, there is no way to forward requests to a server located -somewhere in Europe or Asia. Your website hosted at GitHub Pages will be -downloaded from a central GitHub Pages server. There is a minor risk that if -GitHub Pages DNS servers (=x.x.x.153=) are down for some reason, all custom -domains which use fixed GitHub Pages IP addresses will not be accessible (their -DNS requests will not be resolvable). - -That is why GitHub strongly suggests to either use a second-level domain for -your GitHub Pages (e.g. =blog.example.com=) or use a DNS service provider that -supports a record type =ALIAS= that acts as =A= record but forwards request to a -URL address (e.g. =username.github.io=) instead of a fixed IP address. - -** How GitHub Pages treats HTTP requests - -After a DNS request for =your_github_username.github.io= is resolved into an IP -address, e.g. =185.199.108.153= your browser sends an HTTP request to that -server with an HTTP header =Host=. Below are =curl= examples that load the same -website (these examples might not work if you are behind a proxy server): - -#+BEGIN_SRC sh -curl --header "Host: your_github_username.github.io" http://185.199.108.153/ -curl --header "Host: www.example.com" http://185.199.108.153/ -curl --header "Host: example.com" http://185.199.108.153/ -#+END_SRC - -This way GitHub Pages servers know which user website to serve. - -#+BEGIN_QUOTE -GitHub Pages server will automatically redirect HTTP requests to the top-level -domain if your =CNAME= file contains =example.com= but =www.example.com= is -requested. - -The same is valid if your =CNAME= file contains =www.example.com= but the -header =Host= in the =HTTP= request contains =example.com=. -#+END_QUOTE - -** Why can't I add a =CNAME= record entry that accepts a top-level request (=@=) to my DNS configuration? - -Quote from the GitHub Pages documentation: - -#+BEGIN_QUOTE -Warning: Do not create a CNAME record for your custom apex domain! Doing so -may cause issues with other services, such as email, on that domain. -#+END_QUOTE - -* References: - -1. [[https://docs.github.com/en/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site][Setting up a custom domain with GitHub Pages]] -2. [[https://docs.github.com/en/github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages][My custom domain isn't working]] -3. [[https://serverfault.com/questions/589370/cannot-access-my-github-pages-website-by-ip-address][Cannot access my GitHub Pages website by IP Address]] -4. [[https://stackoverflow.com/questions/23375422/how-do-i-set-up-github-pages-to-redirect-dns-requests-from-a-subdomain-e-g-www][How do I set up GitHub Pages to redirect DNS requests from a subdomain - (e.g. www) to the top-level domain (TLD, Apex record)?]] diff --git a/blog/2020-09-01-visual-recognition.org b/blog/2020-09-01-visual-recognition.org deleted file mode 100644 index 9e4f739..0000000 --- a/blog/2020-09-01-visual-recognition.org +++ /dev/null @@ -1,189 +0,0 @@ -#+date: 2020-09-01 -#+title: IBM Watson Visual Recognition - -* What is IBM Watson? - -If you've never heard of [[https://www.ibm.com/watson][Watson]], this service is a suite of enterprise-ready AI -services, applications, and tooling provided by IBM. Watson contains quite a few -useful tools for data scientists and students, including the subject of this -post today: visual recognition. - -If you'd like to view the official documentation for the Visual Recognition API, -visit the [[https://cloud.ibm.com/apidocs/visual-recognition/visual-recognition-v3?code=python][API Docs]]. - -* Prerequisites - -To be able to use Watson Visual Recognition, you'll need the following: - -1. Create a free account on [[https://www.ibm.com/cloud/watson-studio][IBM Watson Studio]]. -2. Add the [[https://www.ibm.com/cloud/watson-visual-recognition][Watson Visual Recognition]] service to your IBM Watson account. -3. Get your API key and URL. To do this, first go to the [[https://dataplatform.cloud.ibm.com/home2?context=cpdaas][profile dashboard]] for - your IBM account and click on the Watson Visual Recognition service you - created. This will be listed in the section titled *Your services*. Then - click the *Credentials* tab and open the *Auto-generated credentials* - dropdown. Copy your API key and URL so that you can use them in the Python - script later. -4. *[Optional]* While not required, you can also create the Jupyter Notebook for - this project right inside [[https://www.ibm.com/cloud/watson-studio][Watson Studio]]. Watson Studio will save your - notebooks inside an organized project and allow you to use their other - integrated products, such as storage containers, AI models, documentation, - external sharing, etc. - -* Calling the IBM Watson Visual Recognition API - -Okay, now let's get started. - -To begin, we need to install the proper Python package for IBM Watson. - -#+BEGIN_SRC sh -pip install --upgrade --user "ibm-watson>=4.5.0" -#+END_SRC - -Next, we need to specify the API key, version, and URL given to us when we -created the Watson Visual Recognition service. - -#+BEGIN_SRC python -apikey = "<your-apikey>" -version = "2018-03-19" -url = "<your-url>" -#+END_SRC - -Now, let's import the necessary libraries and authenticate our service. - -#+BEGIN_SRC python -import json -from ibm_watson import VisualRecognitionV3 -from ibm_cloud_sdk_core.authenticators import IAMAuthenticator - -authenticator = IAMAuthenticator(apikey) -visual_recognition = VisualRecognitionV3( - version=version, - authenticator=authenticator -) - -visual_recognition.set_service_url(url) -#+END_SRC - -*[Optional]* If you'd like to tell the API not to use any data to improve -their products, set the following header. - -#+BEGIN_SRC python -visual_recognition.set_default_headers({'x-watson-learning-opt-out': "true"}) -#+END_SRC - -Now we have our API all set and ready to go. For this example, I'm going to -include a =dict= of photos to load as we test out the API. - -#+BEGIN_SRC python -data = [ - { - "title": "Grizzly Bear", - "url": "https://example.com/photos/image1.jpg" - }, - { - "title": "Nature Lake", - "url": "https://example.com/photos/image2.jpg" - }, - { - "title": "Welcome Sign", - "url": "https://example.com/photos/image3.jpg" - }, - { - "title": "Honey Badger", - "url": "https://example.com/photos/image4.jpg" - }, - { - "title": "Grand Canyon Lizard", - "url": "https://example.com/photos/image5.jpg" - }, - { - "title": "Castle", - "url": "https://example.com/photos/image6.jpg" - } -] -#+END_SRC - -Now that we've set up our libraries and have the photos ready, let's create a -loop to call the API for each image. The code below shows a loop that calls the -URL of each image and sends it to the API, requesting results with at least 60% -confidence. The results are output to the console with dotted lines separating -each section. - -In the case of an API error, the codes and explanations are output to the -console. - -#+BEGIN_SRC python -from ibm_watson import ApiException - -for x in range(len(data)): -try: - url = data[x]["url"] - images_filename = data[x]["title"] - classes = visual_recognition.classify( - url=url, - images_filename=images_filename, - threshold='0.6', - owners=["IBM"]).get_result() - print("-----------------------------------------------") - print("Image Title: ", data[x]["title"], "\n") - print("Image URL: ", data[x]["url"], "\n") - classification_results = classes["images"][0]["classifiers"][0]["classes"] - for result in classification_results: - print(result["class"], "(", result["score"], ")") - print("-----------------------------------------------") -except ApiException as ex: - print("Method failed with status code " + str(ex.code) + ": " + ex.message) -#+END_SRC - -* The Results - -Here we can see the full result set of our function above. If you view each of -the URLs that we sent to the API, you'll be able to see that it was remarkably -accurate. To be fair, these are clear high-resolution, clear photos shot with a -professional camera. In reality, you will most likely be processing images that -are lower quality and may have a lot of noise in the photo. - -However, we can clearly see the benefit of being able to call this API instead -of attempting to write our own image recognition function. Each of the -classifications returned was a fair description of the image. - -If you wanted to restrict the results to those that are at least 90% confident -or greater, you would simply adjust the =threshold= in the -=visual_recognition.classify()= function. - -When your program runs, it should show the output below for each photo you -provide. - -#+BEGIN_SRC txt ----------------------------------------------------------------- -Image Title: Grizzly Bear -Image URL: https://example.com/photos/image1.jpg - -brown bear ( 0.944 ) -bear ( 1 ) -carnivore ( 1 ) -mammal ( 1 ) -animal ( 1 ) -Alaskan brown bear ( 0.759 ) -greenishness color ( 0.975 ) ----------------------------------------------------------------- -#+END_SRC - -* Discussion - -Now, this was a very minimal implementation of the API. We simply supplied some -images and looked to see how accurate the results were. However, you could -implement this type of API into many machine learning (ML) models. - -For example, you could be working for a company that scans their warehouses or -inventory using drones. Would you want to pay employees to sit there and watch -drone footage all day in order to identify or count things in the video? -Probably not. Instead, you could use a classification system similar to this one -in order to train your machine learning model to correctly identify items that -the drones show through video. More specifically, you could have your machine -learning model watch a drone fly over a field of sheep in order to count how -many sheep are living in that field. - -There are many ways to implement machine learning functionality, but hopefully -this post helped inspire some deeper thought about the tools that can help -propel us further into the future of machine learning and AI. diff --git a/blog/2020-09-22-internal-audit.org b/blog/2020-09-22-internal-audit.org deleted file mode 100644 index 92cb30d..0000000 --- a/blog/2020-09-22-internal-audit.org +++ /dev/null @@ -1,246 +0,0 @@ -#+date: 2020-09-22 -#+title: What is Internal Audit? - -#+CAPTION: Internal Audit Overview -[[https://img.cleberg.net/blog/20200922-what-is-internal-audit/internal-audit-overview.jpg]] - -* Definitions - -One of the many reasons that Internal Audit needs such thorough explaining to -non-auditors is that Internal Audit can serve many purposes, depending on the -organization's size and needs. However, the Institute of Internal Auditors (IIA) -defines Internal Auditing as: - -#+BEGIN_QUOTE -Internal auditing is an independent, objective assurance and consulting activity -designed to add value and improve an organization's operations. It helps an -organization accomplish its objectives by bringing a systematic, disciplined -approach to evaluate and improve the effectiveness of risk management, control, -and governance processes. -#+END_QUOTE - -However, this definition uses quite a few terms that aren't clear unless the -reader already has a solid understanding of the auditing profession. To further -explain, the following is a list of definitions that can help supplement -understanding of internal auditing. - -** Independent - -Independence is the freedom from conditions that threaten the ability of the -internal audit activity to carry out internal audit responsibilities in an -unbiased manner. To achieve the degree of independence necessary to effectively -carry out the responsibilities of the internal audit activity, the chief audit -executive has direct and unrestricted access to senior management and the board. -This can be achieved through a dual-reporting relationship. Threats to -independence must be managed at the individual auditor, engagement, functional, -and organizational levels. - -** Objective - -Objectivity is an unbiased mental attitude that allows internal auditors to -perform engagements in such a manner that they believe in their work product and -that no quality compromises are made. Objectivity requires that internal -auditors do not subordinate their judgment on audit matters to others. Threats -to objectivity must be managed at the individual auditor, engagement, -functional, and organizational levels. - -** Assurance - -Assurance services involve the internal auditor's objective assessment of -evidence to provide opinions or conclusions regarding an entity, operation, -function, process, system, or other subject matters. The internal auditor -determines the nature and scope of an assurance engagement. Generally, three -parties are participants in assurance services: (1) the person or group directly -involved with the entity, operation, function, process, system, or other -subject - (the process owner), (2) the person or group making the assessment - -(the internal auditor), and (3) the person or group using the assessment - (the -user). - -** Consulting - -Consulting services are advisory in nature and are generally performed at the -specific request of an engagement client. The nature and scope of the consulting -engagement are subject to agreement with the engagement client. Consulting -services generally involve two parties: (1) the person or group offering the -advice (the internal auditor), and (2) the person or group seeking and receiving -the advice (the engagement client). When performing consulting services, the -internal auditor should maintain objectivity and not assume management -responsibility. - -** Governance, Risk Management, & Compliance (GRC) - -The integrated collection of capabilities that enable an organization to -reliably achieve objectives, address uncertainty and act with integrity. - -* Audit Charter & Standards - -First, it's important to note that not every organization needs internal -auditors. In fact, it's unwise for an organization to hire internal auditors -unless they have regulatory requirements for auditing and have the capital to -support the department. Internal audit is a cost center that can only affect -revenue indirectly. - -Once an organization determines the need for internal assurance services, they -will hire a Chief Audit Executive and create the audit charter. This charter is -a document, approved by the company's governing body, that will define internal -audit's purpose, authority, responsibility, and position within the -organization. Fortunately, the IIA has model charters available to IIA members -for those developing or improving their charter. - -Beyond the charter and organizational documents, internal auditors follow a few -different standards in order to perform their job. First is the International -Professional Practices Framework (IPPF) by the IIA, which is the model of -standards for internal auditing. In addition, ISACA's Information Technology -Assurance Framework (ITAF) helps guide auditors in reference to information -technology (IT) compliance and assurance. Finally, additional standards such as -FASB, GAAP, and industry-specific standards are used when performing internal -audit work. - -* Three Lines of Defense - -[[https://theiia.org][The IIA]] released the original Three Lines of Defense model in 2013, but have -released an updated version in 2020. Here is what the Three Lines of Defense -model has historically looked like: - -#+CAPTION: 2013 Three Lines of Defense Model -[[https://img.cleberg.net/blog/20200922-what-is-internal-audit/three_lines_model.png]] - -I won't go into depth about the changes made to the model in this article. -Instead, let's take a look at the most current model. - -#+CAPTION: 2020 Three Lines of Defense Model -[[https://img.cleberg.net/blog/20200922-what-is-internal-audit/updated_three_lines_model.png]] - -The updated model forgets the strict idea of areas performing their own -functions or line of defense. Instead of talking about management, risk, and -internal audit as 1-2-3, the new model creates a more fluid and cooperative -model. - -Looking at this model from an auditing perspective shows us that auditors will -need to align, communicate, and collaborate with management, including business -area managers and chief officers, as well as reporting to the governing body. -The governing body will instruct internal audit /functionally/ on their goals -and track their progress periodically. - -However, the internal audit department will report /administratively/ to a chief -officer in the company for the purposes of collaboration, direction, and -assistance with the business. Note that in most situations, the governing body -is the audit committee on the company's board of directors. - -The result of this structure is that internal audit is an independent and -objective function that can provide assurance over the topics they audit. - -* Audit Process - -A normal audit will generally follow the same process, regardless of the topic. -However, certain special projects or abnormal business areas may call for -changes to the audit process. The audit process is not set in stone, it's simply -a set of best practices so that audits can be performed consistently. - -#+CAPTION: The Internal Audit Process -[[https://img.cleberg.net/blog/20200922-what-is-internal-audit/internal-audit-process.jpg]] - -While different organizations may tweak the process, it will generally follow -this flow: - -** 1. Risk Assessment - -The risk assessment part of the process has historically been performed -annually, but many organizations have moved to performing this process much more -frequently. In fact, some organizations are moving to an agile approach that can -take new risks into the risk assessment and re-prioritize risk areas on-the-go. -To perform a risk assessment, leaders in internal audit will research industry -risks, consult with business leaders around the company, and perform analyses on -company data. - -Once a risk assessment has been documented, the audit department has a -prioritized list of risks that can be audited. This is usually in the form of -auditable entities, such as business areas or departments. - -** 2. Planning - -During the planning phase of an audit, auditors will meet with the business area -to discuss the various processes, controls, and risks applicable to the -business. This helps the auditors determine the scope limits for the audit, as -well as timing and subject-matter experts. Certain documents will be created in -this phase that will be used to keep the audit on-track an in-scope as it goes -forward. - -** 3. Testing - -The testing phase, also known as fieldwork or execution, is where internal -auditors will take the information they've discovered and test it against -regulations, industry standards, company rules, best practices, as well as -validating that any processes are complete and accurate. For example, an audit -of HR would most likely examine processes such as employee on-boarding, employee -termination, security of personally identifiable information (PII), or the IT -systems involved in these processes. Company standards would be examined and -compared against how the processes are actually being performed day-to-day, as -well as compared against regulations such as the Equal Employment Opportunity -(EEO), American with Disabilities Act, and National Labor Relations Act. - -** 4. Reporting - -Once all the tests have been completed, the audit will enter the reporting -phase. This is when the audit team will conclude on the evidence they've -collected, interviews they've held, and any opinions they've formed on the -controls in place. A summary of the audit findings, conclusions, and specific -recommendations are officially communicated to the client through a draft -report. Clients have the opportunity to respond to the report and submit an -action plan and time frame. These responses become part of the final report -which is distributed to the appropriate level of administration. - -** 5. Follow-Up - -After audits have been completed and management has formed action plans and time -frames for audit issues, internal audit will follow up once that due date has -arrived. In most cases, the follow-up will simply consist of a meeting to -discuss how the action plan has been completed and to request documentation to -prove it. - -* Audit Department Structure - -While an internal audit department is most often thought of as a team of -full-time employees, there are actually many different ways in which a -department can be structured. As the world becomes more digital and fast-paced, -outsourcing has become a more attractive option for some organizations. Internal -audit can be fully outsourced or partially outsourced, allowing for flexibility -in cases where turnover is high. - -In addition, departments can implement a rotational model. This allows for -interested employees around the organization to rotate into the internal audit -department for a period of time, allowing them to obtain knowledge of risks and -controls and allowing the internal audit team to obtain more business area -knowledge. This program is popular in very large organizations, but -organizations tend to rotate lower-level audit staff instead of managers. This -helps prevent any significant knowledge loss as auditors rotate out to business -areas. - -* Consulting - -Consulting is not an easy task at any organization, especially for a department -that can have negative perceptions within the organization as the "compliance -police." However, once an internal audit department has delivered value to -organization, adding consulting to their suite of services is a smart move. In -most cases, Internal Audit can insert themselves into a consulting role without -affecting the process of project management at the company. This means that -internal audit can add objective assurance and opinions to business areas as -they develop new processes, instead of coming in periodically to audit an area -and file issues that could have been fixed at the beginning. - -* Data Science & Data Analytics - -#+CAPTION: Data Science Skill Set -[[https://img.cleberg.net/blog/20200922-what-is-internal-audit/data-science-skillset.png]] - -One major piece of the internal audit function in the modern world is data -science. While the process is data science, most auditors will refer to anything -in this realm as data analytics. Hot topics such as robotic process automation -(RPA), machine learning (ML), and data mining have taken over the auditing world -in recent years. These technologies have been immensely helpful with increasing -the effectiveness and efficiency of auditors. - -For example, mundane and repetitive tasks can be automated in order for auditors -to make more room in their schedules for labor-intensive work. Further, auditors -will need to adapt technologies like machine learning in order to extract more -value from the data they're using to form conclusions. diff --git a/blog/2020-10-12-mediocrity.org b/blog/2020-10-12-mediocrity.org deleted file mode 100644 index ce79f3b..0000000 --- a/blog/2020-10-12-mediocrity.org +++ /dev/null @@ -1,111 +0,0 @@ -#+date: 2020-10-12 -#+title: On the Pursuit of Mediocrity - -* Perfect is the Enemy of Good - -As the saying goes, "the best is the enemy of the good." As we strive for -perfection, we often fail to realize the implications of such an undertaking. -Attempting to reach perfection is often unrealistic. Even worse, it can get in -the way of achieving a good outcome. In certain situations, we try so hard to -achieve the ideal solution that we have burned the bridges that would have -allowed us to reach a lesser yet still superb solution. - -Philosophers throughout history have inspected this plight from many viewpoints. -Greek mythology speaks of the [[https://en.wikipedia.org/wiki/Golden_mean_(philosophy)][golden mean]], which uses the story of Icarus to -illustrate that sometimes "the middle course" is the best solution. In this -story, Daedalus, a famous artist of his time, built feathered wings for himself -and his son so that they might escape the clutches of King Minos. Daedalus warns -his beloved son whom he loved so much to "fly the middle course", between the -sea spray and the sun's heat. Icarus did not heed his father; he flew up and up -until the sun melted the wax off his wings. For not heeding the middle course, -he fell into the sea and drowned. - -More recently, management scholars have explored the [[https://en.wikipedia.org/wiki/Pareto_principle][Pareto principle]] and found -that as we increase the frequency of something, or strive to perform actions to -achieve some form of perfection, we run into [[https://en.wikipedia.org/wiki/Diminishing_returns][diminishing returns]]. - -Even further, Harold Demsetz is noted as coining the term [[https://en.wikipedia.org/wiki/Nirvana_fallacy][the Nirvana fallacy]] in -1969, which shows the fallacy of comparing actual things with unrealistic, -idealized alternatives. This is another trap that we may fall into, where we are -constantly thinking of the ultimate solutions to problems, when something more -realistic needs to be considered. - -Over and over throughout history, we've found that perfection is often -unrealistic and unachievable. However, we push ourselves and our peers to "give -100%" or "go the extra mile," while it may be that the better course is to give -a valuable level of effort while considering the effects of further effort on -the outcome. Working harder does not always help us achieve loftier goals. - -This has presented itself to me most recently during my time studying at my -university. I was anxious and feeling the stresses of my courses, career, and -personal life for quite a while, which was greatly affecting how well I was -doing at school and my level of effort at work. One day, I happened to be -talking to my father when he said something simple that hit home: - -#+BEGIN_QUOTE -All you can do is show up and do your best. -Worrying about the outcomes won't affect the outcome itself. -#+END_QUOTE - -The thought was extremely straightforward and uncomplicated, yet it was -something that I had lost sight of during my stress-filled years at school. Ever -since then, I've found myself pausing and remembering that quote every time I -get anxious or stressed. It helps to stop and think "Can I do anything to affect -the outcome, or am I simply worrying over something I can't change?" - -* When Mediocrity Isn't Enough - -One problem with the philosophies presented in this post is that they are -implemented far too often in situations where mediocrity simply isn't adequate. -For example, let's take a look at digital user data, specifically -personally-identifiable information (PII). As a cybersecurity auditor in the -United States, I have found that most companies are concerned more with -compliance than any actual safeguards over the privacy or protection of user -data. Other than companies who have built their reputation on privacy and -security, most companies will use [[https://en.wikipedia.org/wiki/Satisficing][satisficing]] as their primary decision-making -strategy around user data. - -#+BEGIN_QUOTE -Satisficing is a decision-making strategy or cognitive heuristic that entails -searching through the available alternatives until an acceptability threshold -is met. -#+END_QUOTE - -This means that each decision will be met with certain possible solutions until -one of the solutions meets their minimum acceptable standards. For companies -that deal with user data, the minimum-acceptable standards come from three -areas: - -1. Laws and regulations -2. Competitive pressure -3. Risk of monetary or reputation loss - -Working with project management or auditing, the primary concern here is the -risk of legal ramifications. Since the primary risk comes from laws and -regulations, companies will require that any project that involves user data -must follow all the rules of those laws so that the company can protect itself -from fines or other penalties. - -Following this, companies will consider best practices in order to place itself -in a competitive position (e.g. Google vs. Apple) and review any recent or -ongoing litigation against companies regarding user data. In a perfect company, -management would then consider the ethical responsibilities of their -organization and discuss their responsibilities over things like -personally-identifiable information. - -However, as we mentioned above, most companies follow the idea of satisficing, -which states that they have met the minimum acceptable standards and can now -move on to other decisions. Modern business culture in the United States -dictates that profits are the golden measure of how well a company or manager is -performing, so we often don't think about our responsibilities beyond these -basic standards. - -Not all situations demand excellence, but I believe that applying any philosophy -as a broad stroke across one's life can be a mistake. We must be able to think -critically about what we are doing as we do it and ask ourselves a few -questions. Have I done everything I can in this situation? Is mediocrity an -acceptable outcome, or should we strive for perfection, even if we can't attain -it? - -Taking a few moments to think critically throughout our day, as we make -decisions, can have a tremendous effect on the outcomes we create. diff --git a/blog/2020-12-27-website-redesign.org b/blog/2020-12-27-website-redesign.org deleted file mode 100644 index 771178a..0000000 --- a/blog/2020-12-27-website-redesign.org +++ /dev/null @@ -1,87 +0,0 @@ -#+date: 2020-12-27 -#+title: Redesigning My Website: The 5 KB Result - -* A Brief History - -As a form of continuous learning and entertainment, I've been running a handful -of websites since 2016 when I took my first programming courses in college. I -maintain one main website, the place I consider the official website to -represent me. Under this site, I have a handful of subdirectories and -subdomains. - -One of the parts I've enjoyed the most about web development is the aspect of -designing an identity for a web page and working to find exciting ways to -display the site's content. Inevitably, this means I've changed the designs for -my websites more times than I could possibly count. Since I don't really host -anything on my main webpage that's vital, it allows me the freedom to change -things as inspiration strikes. - -Historically, I've relied on core utilities for spacing, components, and layouts -from [[https://getbootstrap.com][Bootstrap]] and added custom CSS for fonts, accents, colors, and other -items. I also tend to create sites with no border radius on items, visible -borders, and content that takes up the entire screen (using whitespace inside -components instead of whitespace around my components). - -* The Redesign Process - -About a week ago, I found myself wishing for a new design yet again. The prior -design was largely inspired by IBM's [[https://www.carbondesignsystem.com][Carbon Design System]] and relied on jQuery, -Bootstrap, along with some compressed [[https://en.wikipedia.org/wiki/WebP][.webp]] images. - -To anyone who knows my preferences toward web design - and even in my personal -life - it should be no surprise that I immediately started looking for -inspiration on minimalism. While there are some decent minimalistic designs on -sites like [[https://dribbble.com/search/shots/popular/web-design?q=minimalism][Dribbble]], people seem to mostly discuss [[https://brutalist-web.design][brutalist web design]] when you -ask about minimalism. While brutalist web design doesn't have to be minimal, it -often is. - -I suppose, in a way, I did create a brutalist website since my HTML is semantic -and accessible, hyperlinks are colored and underlined, and all native browser -functions like scrolling and the back button work as expected. However, I didn't -think about brutalism while designing these sites. - -The new design followed a simple design process. I walked through the screens on -my blog and asked myself: "Is this element necessary for a user?" This allowed -me to first start by removing all javascript, which had the sole purpose of -allowing users to open a collapsed navbar on mobile. Replacing the collapsible -navbar allowed me to remove both jQuery and Bootstrap's javascript. - -Next, I removed things like author names (since I'm literally the only person -who will ever write on this site), multiple ways to click on a blog post card, -blog post descriptions, and the scroll-to-top button. It also helped to move all -categories to a single page, rather than have each category on its own page. - -The final big piece to finish the "[[https://en.wikipedia.org/wiki/Marie_Kondo#KonMari_method][KonMari]]"-like part of my process was to -remove Bootstrap CSS in its entirety. However, this meant pulling out a few very -useful classes, such as `.img-fluid` and the default font stacks to keep in my -custom CSS. - -After removing all the unnecessary pieces, I was finally able to reorganize my -content and add a very small amount of custom CSS to make everything pretty. -This took a brief amount of time, effectively just consisting of me -converting =<div>= tags into things like =<ul>= lists and choosing accent -colors. - -* The Results - -** Reflection - -So, what did all of this reorganizing do to my webpages? Well, first, my -websites are now *ridiculously fast*. Since the prior designs were also minimal -and didn't have many images, they measured up in Firefox's Network Monitor -around 300 KB - 600KB. After making the changes, my main site is at 5 KB -transferred (22 KB total), and my blog is at 6.5 KB transferred (13 KB -total). *That means the redesigned pages are less than 2% the size of the old -designs.* - -Google Lighthouse ranks the new webpage as 100 in performance, accessibility, -and best practices, with SEO at 92 since they think tap targets are not sized -appropriately for mobile users. First contextual paints of the pages are under -0.8 seconds with 0 ms of blocking time. However, the blog subdomain ranks at 100 -for all four categories! First contextual paints of the blog homepage are under -1.0 seconds with 0 ms of blocking time, due to the fact that the CSS for my blog -is within a separate CSS file, and the CSS for my main website is simply -embedded in the HTML file. - -Now that everything is complete, I can confidently say I'm happy with the result -and proud to look at the fastest set of websites I've created so far. diff --git a/blog/2020-12-28-neon-drive.org b/blog/2020-12-28-neon-drive.org deleted file mode 100644 index fc17862..0000000 --- a/blog/2020-12-28-neon-drive.org +++ /dev/null @@ -1,83 +0,0 @@ -#+date: 2020-12-28 -#+title: Neon Drive: A Nostalgic 80s Arcade Racing Game - -* Game Description - -[[https://store.steampowered.com/app/433910/Neon_Drive/][Neon Drive]] presents itself as a simple arcade-style game inspired by the arcade -race games of the 1980s, yet it has managed to take up hours of my life without -much effort. The game description, directly from the Steam page, is intriguing -enough to entice anyone who's been looking for a good arcade racing game: - -#+BEGIN_QUOTE -Neon Drive is a slick retro-futuristic arcade game that will make your brain -melt. You've been warned. From beautiful cityscapes and ocean roads to -exploding enemy spaceships, Neon Drive has it all. -#+END_QUOTE - -* Gameplay - -The game holds true to the [[https://en.wikipedia.org/wiki/Retrofuturism][retro-futurism]] style, including chrome female robots, -pixelated arcade machines, and [[https://teddit.net/r/outrun/][outrun]] aesthetics. - -Each level of the game is shown as a separate arcade machine. Each arcade -machine lets you play on Normal, Hard, Insane, Practice, and Free Run. To beat -each arcade, you must reach the end of the level without crashing your car into -the various obstacles on the course. Basic levels let you move left or right to -avoid blocks in the road. Later levels put you through other tests, such as -dodging traffic or blasting asteroids. - -The game uses synthwave music to keep you on track to make the correct moves by -timing the beats of the songs to the correct moves on the screen. It reminds me -of the early Guitar Hero games, as well as mobile apps like VOEZ - repetition -and staying on-beat is the only way to win. - -* In-Game Screenshots - -Taking a look at the main menu, you can see that Neon Drive plays into every -stereotype you can think of around retro-futuristic, synthwave arcades (in a -good way). - -#+CAPTION: Neon Drive Menu -[[https://img.cleberg.net/blog/20201228-neon-drive/neon_drive_menu.png]] - -Once you get into the first level, we see that the choice of car fits right in -with the stereotypical cars of the 80s, like the [[https://en.wikipedia.org/wiki/DMC_DeLorean][DeLorean]] or the [[https://en.wikipedia.org/wiki/Ferrari_F40][Ferrari -F40]]. Each new level comes with new color schemes and cars, so you should never -get tired of the aesthetic. - -#+CAPTION: Neon Drive Race -[[https://img.cleberg.net/blog/20201228-neon-drive/neon_drive_race.png]] - -Personally, I love the orange and blue colors used in level 2: - -#+CAPTION: Level 2 -[[https://img.cleberg.net/blog/20201228-neon-drive/neon_drive_level_2.png]] - -If you're the competitive type and getting 100% on all arcade machines isn't -enough, there are leaderboards for the regular part of the game, and the -endurance game mode. - -#+CAPTION: Leaderboard -[[https://img.cleberg.net/blog/20201228-neon-drive/neon_drive_leaderboard.png]] - -* Other Suggestions - -Neon Drive sits nicely within the well-founded cult genre of Outrun. Other games -that I've enjoyed in this same spectrum are: - -- [[https://store.steampowered.com/app/233270/Far_Cry_3__Blood_Dragon/][Far Cry 3: Blood Dragon]] -- [[https://store.steampowered.com/app/1239690/Retrowave/][Retrowave]] -- [[https://store.steampowered.com/app/732810/Slipstream/][Slipstream]] - -Although these games aren't necessarily in the same genre, they do have aspects -that place them close enough to interest gamers that enjoyed Neon Drive: - -- [[https://store.steampowered.com/app/311800/Black_Ice/][Black Ice]] -- [[https://store.steampowered.com/app/746850/Cloudpunk/][Cloudpunk]] -- [[https://store.steampowered.com/app/1222680/Need_for_Speed_Heat/][Need for Speed: Heat]] -- [[https://store.steampowered.com/app/1019310/VirtuaVerse/][VirtuaVerse]] - -Of course, if all you really care about is the arcade aspect of these games, you -can check out the [[https://store.steampowered.com/app/400020/Atari_Vault/][Atari Vault]] or any of the other classic games sold on Steam by -companies like Namco, Atari. For something like Nintendo, you'd have to settle -for buying used classic consoles or delve into the world of emulation. diff --git a/blog/2020-12-29-zork.org b/blog/2020-12-29-zork.org deleted file mode 100644 index 7ac950c..0000000 --- a/blog/2020-12-29-zork.org +++ /dev/null @@ -1,80 +0,0 @@ -#+date: 2020-12-29 -#+title: Zork: Let's Explore a Classic - -* Download (Free) - -Before we get into the game itself, you should know that you can download Zork -for free from Infocom's [[http://infocom-if.org/downloads/downloads.html][download page]]. So feel free to boot it up and take a -ride back to the 1980s with this masterpiece. - -* Game Description - -Zork is an interactive, text-based computer game originally released in 1980. -This series, split into three separate games, introduced a robust and -sophisticated text parser to gamers. People were largely used to the simple -commands used in the popular game [[https://en.wikipedia.org/wiki/Colossal_Cave_Adventure][Colossal Cave Adventure]], but Zork allowed -users to send more complex commands that included prepositions and conjunctions. - -Zork tracks your score as you explore the map, find tools, and collect trophy -items (e.g., a jewel-encrusted egg). When you place your trophy items in the -trophy case found in the Living Room area, you gain score points. Collecting the -Twenty Treasures of Zork and placing them within the trophy case wins the -game. However, you must explore the map, solve puzzles, and avoid being eaten by -a grue to collect these treasures. - -* The Map - -Since Zork is a vast and complex game, it helps to have a map as you explore and -collect your trophies. However, if you want to play the game as it was truly -intended, you should try to play it without using the map. - -#+CAPTION: Zork Map -[[https://img.cleberg.net/blog/20201229-zork/zork_map.png]] - -/[[https://www.filfre.net/2012/01/exploring-zork-part-1/][Map Source]]/ - -* In-Game Screenshots - -After playing the game (for the first time ever) for several weeks around 2014, -I was finally able to beat the game with some online help to find the last -couple items. As I was writing this post, I installed the game again to grab -some screenshots to show off the true glory of this game. As noted in [[https://www.filfre.net/2012/01/exploring-zork-part-1/][Jimmy -Maher's playthrough]], the original Zork games looked quite a bit different due to -the older hardware of computers like the Apple II and multiple bug fixes that -Infocom pushed out after the game's initial release. My play-through uses the -[[https://store.steampowered.com/app/570580/Zork_Anthology/][Zork Anthology]] version, which utilizes DOSBox on Windows. - -The first screenshot here shows the introductory information, which doesn't -include instructions of any kind for the player. If you haven't played text -adventures before, try to use simple commands like "go west," "look around," or -"hit troll with elvish sword." - -#+CAPTION: Zork Screen, pt. 1 -[[https://img.cleberg.net/blog/20201229-zork/zork_01.png]] - -In this second screenshot, we see the player has entered the house and found the -trophy case in the living room. The lantern and sword in this room allow the -player to explore dark areas and attack enemies. If you don't use the lantern, -you won't be able to see anything in dark areas, and you may be eaten by a grue. - -#+CAPTION: Zork Screen, pt. 2 -[[https://img.cleberg.net/blog/20201229-zork/zork_02.png]] - -Finally, we see that the player has found the first treasure: a jewel-encrusted -egg. These treasures can be taken back to the house and placed in the trophy -case or carried until you feel like you want to put things away. - -#+CAPTION: Zork Screen, pt 3. -[[https://img.cleberg.net/blog/20201229-zork/zork_03.png]] - -* Conclusion - -It's been quite a few years since I first played Zork, but I clearly remember -the late nights and bloodshot eyes that helped me find all the treasures. This -game is well worth the time and effort, even though the text-based aspect may be -off-putting to gamers who didn't have to grow up playing games without graphics. -However, I believe that the strategy and skills learned in early video games -like Zork can actually help you, even when playing newer games. - -If you do decide to play Zork, you can download Zork I, II, and III from -Infocom's [[http://infocom-if.org/downloads/downloads.html][download page]] for free or search the internet for an online version. diff --git a/blog/2021-10-09-apache-redirect.org b/blog/2021-10-09-apache-redirect.org deleted file mode 100644 index f925f31..0000000 --- a/blog/2021-10-09-apache-redirect.org +++ /dev/null @@ -1,47 +0,0 @@ -#+title: Apache Redirect HTML Files to a Directory -#+date: 2021-10-10 - -** The Problem -:PROPERTIES: -:CUSTOM_ID: the-problem -:END: -After recently switching static site generators (SSG), my blog URLs -changed with no option to preserve the classic =.html= extension at the -end of my blog post URLs. - -I really disliked using my old SSG ([[https://jekyllrb.com][Jekyll]]) -and prefer my new tool ([[https://www.getzola.org][Zola]]) much more, so -I was determined to figure out a way to get the proper redirect set up -so that people who find my posts online aren't constantly met by 404 -errors. - -** The Solution -:PROPERTIES: -:CUSTOM_ID: the-solution -:END: -To solve this problem, I really needed to solve two pieces: - -1. Redirect all blog post URL requests from =/blog/some-post.html= to - =/blog/some-post/=. -2. Ensure that no other =.html= files are redirected, such as - =index.html=. - -After /a lot/ of tweaking and testing, I believe I have finally found -the solution. The solution is shown below. - -#+begin_src config -RewriteEngine On -RewriteCond %{REQUEST_URI} !\index.html$ [NC] -RewriteRule ^(.*).html$ https://example.com/$1 [R=301,L] -#+end_src - -This piece of code in the Apache =.conf= or =.htaccess= file will do the -following: - -1. Turn on the RewriteEngine so that we can modify URLs. -2. Ignore any =index.html= files from the rule we are about to specify. -3. Find any =.html= files within the website directory and redirect it - to exclude the file extension. -4. The final piece is adding the trailing slash (=/=) at the end of the - URL - you'll notice that I don't have an Apache rule for that since - Apache handles that automatically. diff --git a/blog/2022-02-17-exiftool.org b/blog/2022-02-17-exiftool.org deleted file mode 100644 index 790e1a1..0000000 --- a/blog/2022-02-17-exiftool.org +++ /dev/null @@ -1,67 +0,0 @@ -#+title: Stripping Image Metadata with exiftool -#+date: 2022-02-17 - -** Why Strip Metadata? -:PROPERTIES: -:CUSTOM_ID: why-strip-metadata -:END: -Okay, so you want to strip metadata from your photos. Perhaps you take -pictures of very rare birds, and the location metadata is a gold mine -for poachers, or perhaps you're just privacy-oriented like me and prefer -to strip metadata from publicly-available images. - -There are various components of image metadata that you may want to -delete before releasing a photo to the public. Here's an incomplete list -of things I could easily see just by inspecting a photo on my laptop: - -- Location (Latitude & Longitude) -- Dimensions -- Device Make & Model -- Color Space -- Color Profile -- Focal Length -- Alpha Channel -- Red Eye -- Metering Mode -- F Number - -Regardless of your reasoning, I'm going to explain how I used the -=exiftool= package in Linux to automatically strip metadata from all -images in a directory (+ subdirectories). - -** Installing =exiftool= -:PROPERTIES: -:CUSTOM_ID: installing-exiftool -:END: -First things first: we need to install the tool. I'm running Debian 11 -on my server (Ubuntu will work the same), so the command is as simple -as: - -#+begin_src sh -sudo apt install exiftool -#+end_src - -There are different tools that can accomplish the same thing across -distributions, but I really only care to test out this one package. - -** Recursively Strip Data -:PROPERTIES: -:CUSTOM_ID: recursively-strip-data -:END: -I actually use this tool extensively to strip any photos uploaded to the -website that serves all the images for my blog (=img.cleberg.net=). - -The following command is incredibly useful and can be modified to -include any image extensions that =exiftool= supports: - -#+begin_src sh -exiftool -r -all= -ext jpg -ext png /path/to/directory/ -#+end_src - -See below for the results of my most recent usage of =exiftool= after I -uploaded the image for this blog post. You can see that the command will -let you know how many directories were scanned, how many images were -updated, and how many images were unchanged. - -#+caption: exiftool results -[[https://img.cleberg.net/blog/20220217-stripping-metadata-with-exiftool/exiftool.png]] diff --git a/blog/2022-02-20-nginx-caching.org b/blog/2022-02-20-nginx-caching.org deleted file mode 100644 index 7f16932..0000000 --- a/blog/2022-02-20-nginx-caching.org +++ /dev/null @@ -1,75 +0,0 @@ -#+title: Caching Static Content with Nginx -#+date: 2022-02-20 - -** Update Your Nginx Config to Cache Static Files -:PROPERTIES: -:CUSTOM_ID: update-your-nginx-config-to-cache-static-files -:END: -If you run a website on Nginx that serves static content (i.e., content -that is not dynamic and changing with interactions from the user), you -would likely benefit from caching that content on the client-side. If -you're used to Apache and looking for the Nginx equivalent, this post -should help. - -Luckily, setting up the cache is as easy as identifying the file types -you want to cache and determining the expiration length. To include more -file types, simply use the bar separator (=|=) and type the new file -extension you want to include. - -#+begin_src config -server { - ... - - location ~* .(css|js|jpg|jpeg|gif|png|ico)$ { - expires 30d; - } - - ... -} -#+end_src - -I have seen some people who prefer to set =expires= as =365d= or even -=max=, but that is only for stable, infrequently changing websites. As -my site often changes (i.e., I'm never content with my website), I need -to know that my readers are seeing the new content without waiting too -long. - -So, I went ahead and set the expiration date at =30d=, which is short -enough to refresh for readers but long enough that clients/browsers -won't be re-requesting the static files too often, hopefully resulting -in faster loading times, as images should be the only thing slowing down -my site. - -** Testing Results -:PROPERTIES: -:CUSTOM_ID: testing-results -:END: -To test my changes to the Nginx configuration, I used the -[[https://addons.mozilla.org/en-US/firefox/addon/http-header-live/][HTTP -Header Live]] extension on my Gecko browser and used the sidebar to -inspect the headers of a recent image from my blog. - -In the image below, you can see that the =Cache-Control= header is now -present and set to 2592000, which is 30 days represented in seconds (30 -days _ 24 hours/day _ 60 minutes/hour * 60 seconds/minute = 2,592,000 -seconds). - -The =Expires= field is now showing 22 March 2022, which is 30 days from -the day of this post, 20 February 2022. - -#+caption: Image Headers -[[https://img.cleberg.net/blog/20220220-caching-static-content-with-nginx/image_headers.png]] - -** Caveats -:PROPERTIES: -:CUSTOM_ID: caveats -:END: -Remember that this caching system is *client-side*, which means that -content is only cached for as long as a client allows it. For example, -my browser purges all caches, data, etc. upon exit, so this caching -policy will only work as long as my browser remains open and running. - -If you need to test updates to your site, you'll need to clear the cache -to see updates for any file extension you configured. This can often be -done with the =Shift + F5= or =Ctrl + F5= key combinations in most -browsers. diff --git a/blog/2022-02-22-tuesday.org b/blog/2022-02-22-tuesday.org deleted file mode 100644 index 1c9efb5..0000000 --- a/blog/2022-02-22-tuesday.org +++ /dev/null @@ -1,38 +0,0 @@ -#+title: Tuesday -#+date: 2022-02-22 - -** Tuesday, Twosday -:PROPERTIES: -:CUSTOM_ID: tuesday-twosday -:END: -I'm taking a break from my usual technology-related posts and writing -about something a little more enjoyable today. - -Today is Tuesday, February 22nd, 2022. Today is 02-22-2022. Today is -Twosday. - -Let's look at everything that fell in place today: - -1. Written in the =m-dd-yy= or =dd-m-yy= formats, today is 2-22-22 or - 22-2-22, which is a neat little palindrome in either format. (The - last ubiquitous six-digit palindrome was 1-11-11.) -2. Today is Tuesday, which is why everyone is using the nickname Twosday - to call out these similarities. -3. Falling on Tuesday means today is the 2nd day of the week (for most - cultures. For the US, it's the 3rd day of the week since we start on - Sunday). -4. The only culture I could find with a connection to a =2= is that some - Slavic languages derived their version of Tuesday from the Old Church - Slavonic word =въторъ=, meaning "the second." -5. Written in the classic monospaced, digital font (think of digital - clocks from the 80s/90s), there is nice symmetry to the numbers - ([[https://img.cleberg.net/blog/20220222-tuesday/digital_font.png][view - the image here]]!). -6. This one isn't naturally-occurring, but it seems people around the - world are celebrating the day. For example, a group is putting - together - [[https://www.eventbrite.com/e/2-22-22-a-collective-wedding-ceremony-at-the-state-capitol-tickets-211434605597][a - wedding of 222 couples at the California State Capitol in - Sacramento]], concluding at exactly 2:22 PM. These couples will - record their marriage dates as 2-22-22 2:22 PM. Tickets were on sale - for $222.22. diff --git a/blog/2022-03-03-financial-database.org b/blog/2022-03-03-financial-database.org deleted file mode 100644 index c097c64..0000000 --- a/blog/2022-03-03-financial-database.org +++ /dev/null @@ -1,272 +0,0 @@ -#+title: Maintaining a Personal Financial Database -#+date: 2022-03-03 - -** Personal Financial Tracking -:PROPERTIES: -:CUSTOM_ID: personal-financial-tracking -:END: -For the last 6-ish years, I've tracked my finances in a spreadsheet. -This is common practice in the business world, but any good dev will -cringe at the thought of storing long-term data in a spreadsheet. A -spreadsheet is not for long-term storage or as a source of data to pull -data/reports. - -As I wanted to expand the functionality of my financial data (e.g., -adding more reports), I decided to migrate the data into a database. To -run reports, I would query the database and use a language like Python -or Javascript to process the data, perform calculations, and visualize -the data. - -** SQLite -:PROPERTIES: -:CUSTOM_ID: sqlite -:END: -When choosing the type of database I wanted to use for this project, I -was split between three options: - -1. MySQL: The database I have the most experience with and have used for - years. -2. PostgreSQL: A database I'm new to, but want to learn. -3. SQLite: A database that I've used for a couple projects and have - moderate experience. - -I ended up choosing SQLite since it can be maintained within a single -=.sqlite= file, which allows me more flexibility for storage and backup. -I keep this file in my cloud storage and pull it up whenever needed. - -*** GUI Editing -:PROPERTIES: -:CUSTOM_ID: gui-editing -:END: -Since I didn't want to try and import 1000--1500 records into my new -database via the command line, I opted to use -[[https://sqlitebrowser.org/][DB Browser for SQLite (DB4S)]] as a GUI -tool. This application is excellent, and I don't see myself going back -to the CLI when working in this database. - -DB4S allows you to copy a range of cells from a spreadsheet and paste it -straight into the SQL table. I used this process for all 36 accounts, -1290 account statements, and 126 pay statements. Overall, I'm guessing -this took anywhere between 4--8 hours. In comparison, it probably took -me 2-3 days to initially create the spreadsheet. - -#+caption: DB4S -[[https://img.cleberg.net/blog/20220303-maintaining-a-personal-financial-database/db4s.png]] - -*** Schema -:PROPERTIES: -:CUSTOM_ID: schema -:END: -The schema for this database is actually extremely simple and involves -only three tables (for now): - -1. Accounts -2. Statements -3. Payroll - -*Accounts* - -The Accounts table contains summary information about an account, such -as a car loan or a credit card. By viewing this table, you can find -high-level data, such as interest rate, credit line, or owner. - -#+begin_src sql -CREATE TABLE "Accounts" ( - "AccountID" INTEGER NOT NULL UNIQUE, - "AccountType" TEXT, - "AccountName" TEXT, - "InterestRate" NUMERIC, - "CreditLine" NUMERIC, - "State" TEXT, - "Owner" TEXT, - "Co-Owner" TEXT, - PRIMARY KEY("AccountID" AUTOINCREMENT) -) -#+end_src - -*Statements* - -The Statements table uses the same unique identifier as the Accounts -table, meaning you can join the tables to find a monthly statement for -any of the accounts listed in the Accounts table. Each statement has an -account ID, statement date, and total balance. - -#+begin_src sql -CREATE TABLE "Statements" ( - "StatementID" INTEGER NOT NULL UNIQUE, - "AccountID" INTEGER, - "StatementDate" INTEGER, - "Balance" NUMERIC, - PRIMARY KEY("StatementID" AUTOINCREMENT), - FOREIGN KEY("AccountID") REFERENCES "Accounts"("AccountID") -) -#+end_src - -*Payroll* - -The Payroll table is a separate entity, unrelated to the Accounts or -Statements tables. This table contains all information you would find on -a pay statement from an employer. As you change employers or obtain new -perks/benefits, just add new columns to adapt to the new data. - -#+begin_src sql -CREATE TABLE "Payroll" ( - "PaycheckID" INTEGER NOT NULL UNIQUE, - "PayDate" TEXT, - "Payee" TEXT, - "Employer" TEXT, - "JobTitle" TEXT, - "IncomeRegular" NUMERIC, - "IncomePTO" NUMERIC, - "IncomeHoliday" NUMERIC, - "IncomeBonus" NUMERIC, - "IncomePTOPayout" NUMERIC, - "IncomeReimbursements" NUMERIC, - "FringeHSA" NUMERIC, - "FringeStudentLoan" NUMERIC, - "Fringe401k" NUMERIC, - "PreTaxMedical" NUMERIC, - "PreTaxDental" NUMERIC, - "PreTaxVision" NUMERIC, - "PreTaxLifeInsurance" NUMERIC, - "PreTax401k" NUMERIC, - "PreTaxParking" NUMERIC, - "PreTaxStudentLoan" NUMERIC, - "PreTaxOther" NUMERIC, - "TaxFederal" NUMERIC, - "TaxSocial" NUMERIC, - "TaxMedicare" NUMERIC, - "TaxState" NUMERIC, - PRIMARY KEY("PaycheckID" AUTOINCREMENT) -) -#+end_src - -*** Python Reporting -:PROPERTIES: -:CUSTOM_ID: python-reporting -:END: -Once I created the database tables and imported all my data, the only -step left was to create a process to report and visualize on various -aspects of the data. - -In order to explore and create the reports I'm interested in, I utilized -a two-part process involving Jupyter Notebooks and Python scripts. - -**** Step 1: Jupyter Notebooks -:PROPERTIES: -:CUSTOM_ID: step-1-jupyter-notebooks -:END: -When I need to explore data, try different things, and re-run my code -cell-by-cell, I use Jupyter Notebooks. For example, I explored the -=Accounts= table until I found the following useful information: - -#+begin_src python -import sqlite3 -import pandas as pd -import matplotlib - -# Set up database filename and connect -db = "finances.sqlite" -connection = sqlite3.connect(db) -df = pd.read_sql_query("SELECT * FROM Accounts", connection) - -# Set global matplotlib variables -%matplotlib inline -matplotlib.rcParams['text.color'] = 'white' -matplotlib.rcParams['axes.labelcolor'] = 'white' -matplotlib.rcParams['xtick.color'] = 'white' -matplotlib.rcParams['ytick.color'] = 'white' -matplotlib.rcParams['legend.labelcolor'] = 'black' - -# Display graph -df.groupby(['AccountType']).sum().plot.pie(title='Credit Line by Account Type', y='CreditLine', figsize=(5,5), autopct='%1.1f%%') -#+end_src - -**** Step 2: Python Scripts -:PROPERTIES: -:CUSTOM_ID: step-2-python-scripts -:END: -Once I explored enough through the notebooks and had a list of reports I -wanted, I moved on to create a Python project with the following -structure: - -#+begin_example -finance/ -├── notebooks/ -│ │ ├── account_summary.ipynb -│ │ ├── account_details.ipynb -│ │ └── payroll.ipynb -├── public/ -│ │ ├── image-01.png -│ │ └── image-0X.png -├── src/ -│ └── finance.sqlite -├── venv/ -├── _init.py -├── database.py -├── process.py -├── requirements.txt -└── README.md -#+end_example - -This structure allows me to: - -1. Compile all required python packages into =requirements.txt= for easy - installation if I move to a new machine. -2. Activate a virtual environment in =venv/= so I don't need to maintain - a system-wide Python environment just for this project. -3. Keep my =notebooks/= folder to continuously explore the data as I see - fit. -4. Maintain a local copy of the database in =src/= for easy access. -5. Export reports, images, HTML files, etc. to =public/=. - -Now, onto the differences between the code in a Jupyter Notebook and the -actual Python files. To create the report in the Notebook snippet above, -I created the following function inside =process.py=: - -#+begin_src python -# Create summary pie chart -def summary_data(accounts: pandas.DataFrame) -> None: - accounts_01 = accounts[accounts["Owner"] == "Person01"] - accounts_02 = accounts[accounts["Owner"] == "Person02"] - for x in range(1, 4): - if x == 1: - df = accounts - account_string = "All Accounts" - elif x == 2: - df = accounts_01 - account_string = "Person01's Accounts" - elif x == 3: - df = accounts_02 - account_string = "Person02's Accounts" - print(f"Generating pie chart summary image for {account_string}...") - summary_chart = ( - df.groupby(["AccountType"]) - .sum() - .plot.pie( - title=f"Credit Line by Type for {account_string}", - y="CreditLine", - autopct="%1.1f%%", - ) - ) - summary_chart.figure.savefig(f"public/summary_chart_{x}.png", dpi=1200) -#+end_src - -The result? A high-quality pie chart that is read directly by the -=public/index.html= template I use. - -#+caption: Summary Pie Chart -[[https://img.cleberg.net/blog/20220303-maintaining-a-personal-financial-database/summary_chart.png]] - -Other charts generated by this project include: - -- Charts of account balances over time. -- Line chart of effective tax rate (taxes divided by taxable income). -- Salary projections and error limits using past income and inflation - rates. -- Multi-line chart of gross income, taxable income, and net income. - -The best thing about this project? I can improve it at any given time, -shaping it into whatever helps me the most for that time. I imagine that -I will be introducing an asset tracking table soon to track the -depreciating value of cars, houses, etc. Who knows what's next? diff --git a/blog/2022-03-08-plex-migration.org b/blog/2022-03-08-plex-migration.org deleted file mode 100644 index 5546942..0000000 --- a/blog/2022-03-08-plex-migration.org +++ /dev/null @@ -1,270 +0,0 @@ -#+title: Migrating Plex to New Server (+ Nvidia Transcoding) -#+date: 2022-03-08 - -** Migration Phases -:PROPERTIES: -:CUSTOM_ID: migration-phases -:END: -I recently decided to migrate my server from an old OptiPlex desktop -machine to a custom-built tower with better hardware in every category. -In order to do this, I would need to properly migrate a full Plex -installation. - -The second part of this migration is that the new server uses an Nvidia -GPU and does not have any integrated graphics, which requires extra work -for installation, but provides much better hardware transcoding options -for Plex. - -Therefore, I have broken this migration down into three phases: - -1. [[#phase-1-configure-the-new-server][Configure the New Server]] -2. [[#phase-2-migrate-plex-data-devices][Migrate Plex Data & Devices]] -3. [[#phase-3-configure-gpu-transcoding][Configure GPU Transcoding]] - --------------- - -** Phase 1: Configure the New Server -:PROPERTIES: -:CUSTOM_ID: phase-1-configure-the-new-server -:END: -*** Choosing an OS -:PROPERTIES: -:CUSTOM_ID: choosing-an-os -:END: -In order to migrate Plex to my new server, I first needed to choose an -appropriate operating system (OS) and install it on the machine. Given -that I have encountered numerous issues installing other Linux -distributions properly with Nvidia graphics, I chose -[[https://ubuntu.com/download/server][Ubuntu Server]]. - -The first step is to create a bootable USB with Ubuntu Server. This is -easy with [[https://www.balena.io/etcher/][Etcher]], an app that runs on -many different platforms. Just download the Ubuntu Server =.iso= image, -launch Etcher, and install the =.iso= on the USB. - -Once the USB is created, insert it into my server, reboot, and click -=Esc= (or any of the =F1-12= keys) until the BIOS menu appears. Finally, -launch the USB boot drive. - -*** Booting with Nvidia -:PROPERTIES: -:CUSTOM_ID: booting-with-nvidia -:END: -In order to install Ubuntu Server with an Nvidia Graphics card (and no -integrated graphics on this device for some reason), you'll have to -configure the boot menu to allow different graphics drivers to be -loaded. - -When booting from the USB, the machine will launch the initial -installation menu. From this menu, type =e= to view the default command -options that come with the device - it's a good idea to take a photo of -this screen, so you can enter these commands on the next screen (along -with adding support for Nvidia). - -Finally, type =Ctrl + C= to enter the command line. From this command -line, enter the commands found on the =e= screen. *Remember to add -=nomodeset= to the =linux ...= line so that your Nvidia device will -display the installation screens properly!* - -Here's an example of the commands I pulled from the =e= screen and -entered on the command line. - -#+begin_src sh -setparams 'Install Ubuntu Server' -setgfxpayload=keep -linux /casper/vmlinuz quiet nomodeset --- -initrd /casper/initrd -boot -#+end_src - -#+caption: Ubuntu Server Installation 01 -[[https://img.cleberg.net/blog/20220308-plex-media-server-migration/ubuntu_server_installation_01.png]] - -#+caption: Ubuntu Server Installation 02 -[[https://img.cleberg.net/blog/20220308-plex-media-server-migration/ubuntu_server_installation_02.png]] - -Once the machine is rebooted, enter the =e= screen again and add -=nomodeset= to the =linux ...= line again and press =Ctrl + X= to save -the boot options. - -The machine is now fully installed and can properly display on an -external display using the Nvidia GPU. - -Always remember to update and upgrade on a new installation: - -#+begin_src sh -sudo apt update; sudo apt upgrade -y; sudo apt autoremove -y -#+end_src - --------------- - -** Phase 2: Migrate Plex Data & Devices -:PROPERTIES: -:CUSTOM_ID: phase-2-migrate-plex-data-devices -:END: -This phase uses the great Plex article on migrations -([[https://support.plex.tv/articles/201370363-move-an-install-to-another-system/][Move -an Installation to Another System]]) and adds a bit more information to -help with commands and context. - -*** Terminology -:PROPERTIES: -:CUSTOM_ID: terminology -:END: -*Source:* The original server that is being replaced.\\ -*Destination:* The new server.\\ -*Client:* Any application that can be used to modify settings for both -source/destination. - -*** Step 01: [Client] Update Settings -:PROPERTIES: -:CUSTOM_ID: step-01-client-update-settings -:END: -Open up a Plex app and /disable/ the =Account= > =Library= > -=Empty trash automatically after every scan= preference for the source -server. - -*** Step 02: [Destination] Install Plex -:PROPERTIES: -:CUSTOM_ID: step-02-destination-install-plex -:END: -Open up the [[https://www.plex.tv/media-server-downloads/][Plex Media -Server download page]] and copy the link for the appropriate platform. - -Execute the following commands on the destination server to install -Plex: - -#+begin_src sh -wget <url> -sudo dpkg -i <filename> -sudo systemctl stop plexmediaserver.service -#+end_src - -*** Step 03: [Source] Stop Plex & Migrate Data -:PROPERTIES: -:CUSTOM_ID: step-03-source-stop-plex-migrate-data -:END: -First, stop the Plex service so that no data is created or modified -during the migration. - -#+begin_src sh -sudo systemctl stop plexmediaserver.service -#+end_src - -Next, copy the data to the new server. To find where the Plex data -directory is located, Plex has another excellent article available: -[[https://support.plex.tv/articles/202915258-where-is-the-plex-media-server-data-directory-located/][Where -is the Plex Media Server data directory located?]]. - -There are many ways to copy the data to the new server and will largely -depend on the size of the folder being copied. Personally, my data -folder was ~23GB and I opted to simply use the =scp= command to copy the -files over SSH. - -This process was throttled by the old server's slow HDD and ports and -took approximately 90 minutes to complete. In comparison, moving the -data from the new server's =home/user/= directory to the -=/var/.../Plex Media Server= directory took 2-3 minutes. - -#+begin_src sh -scp -r "/var/lib/plexmediaserver/Library/Application Support/Plex Media Server" your_user@xxx.xxx.xxx.xxx:"'/path/to/destination/'" -#+end_src - -*** Step 04: [Destination] Update File Permissions -:PROPERTIES: -:CUSTOM_ID: step-04-destination-update-file-permissions -:END: -In case you move the data directory to a common area on the new server, -it will have to be moved to the proper location before Plex can function -properly: - -#+begin_src sh -mv "Plex Media Server" /var/lib/plexmediaserver/Library/Application Support/ -#+end_src - -To ensure permissions were retained properly, the server will need to -show that all files and folders in the data directory are owned by -=plex:plex= (or whichever user is running the Plex application). - -#+begin_src sh -sudo chown -R plex:plex "/var/lib/plexmediaserver/Library/Application Support/Plex Media Server" -#+end_src - -Finally, start the service and check the status. - -#+begin_src sh -sudo systemctl start plexmediaserver.service -sudo systemctl status plexmediaserver.service -#+end_src - -*** Step 05: [Client] Update Libraries & Metadata -:PROPERTIES: -:CUSTOM_ID: step-05-client-update-libraries-metadata -:END: -The first step - now that the new server is up and running - is to sign -out of the client and sign back in. Once this is done, update any -library locations, if necessary. This was unnecessary in my case since I -simply moved my storage drives from the source server to the destination -server. - -Next, perform the following actions in the client: - -1. On the left sidebar, click =More= > Three-Dot Menu > - =Scan Library Files= -2. /Enable/ the =Account= > =Library= > - =Empty trash automatically after every scan= preference for the - source server. -3. On the left sidebar, click =More= > Three-Dot Menu > =Manage Server= - > =Empty Trash= -4. On the left sidebar, click =More= > Three-Dot Menu > =Manage Server= - > =Clean Bundles= -5. On the left sidebar, click =More= > Three-Dot Menu > =Manage Server= - > =Optimize Database= - -Finally, double-check the Remote Access settings to make sure no changes -have caused issues with accessing the server from outside the network. - -In my case, I use a single port forwarding rule in my router and needed -to update the Local LAN IP Address to the new server IP address. - -#+caption: Router port forwarding -[[https://img.cleberg.net/blog/20220308-plex-media-server-migration/port_forwarding.png]] - --------------- - -** Phase 3: Configure GPU Transcoding -:PROPERTIES: -:CUSTOM_ID: phase-3-configure-gpu-transcoding -:END: -The final piece to the migration is enabling hardware transcoding so -that Plex can fully utilize the new Nvidia GPU available in the server. -The first step is to install Nvidia graphics drivers. This process may -take a few minutes, but the commands are pretty simple: - -#+begin_src sh -sudo add-apt-repository ppa:graphics-drivers/ppa -sudo apt update -sudo apt-get install ubuntu-drivers-common -sudo ubuntu-drivers autoinstall -#+end_src - -Finally, reboot so that the changes are loaded: - -#+begin_src sh -sudo reboot now -#+end_src - -To ensure that the Nvidia graphics drivers are working properly, run the -following command to view the available GPUs, statistics, and processes: - -#+begin_src sh -sudo nvidia-smi -#+end_src - -#+caption: nvidia-smi -[[https://img.cleberg.net/blog/20220308-plex-media-server-migration/nvidia_smi.png]] - -Finally, enable hardware transcoding settings in the Plex application: - -#+caption: Plex transcoding settings -[[https://img.cleberg.net/blog/20220308-plex-media-server-migration/plex_transcoding.png]] diff --git a/blog/2022-03-24-server-hardening.org b/blog/2022-03-24-server-hardening.org deleted file mode 100644 index 88fd44e..0000000 --- a/blog/2022-03-24-server-hardening.org +++ /dev/null @@ -1,386 +0,0 @@ -#+title: Hardening a Public-Facing Home Server -#+date: 2022-03-24 - -** Post Updates -:PROPERTIES: -:CUSTOM_ID: post-updates -:END: - -#+begin_quote -After reviewing this post today (2022-10-04), I noticed quite a few gaps -in my write-up and wanted to add a few things, even though this blog is -really just a retrospective and knowledge dump for myself. I left things -intact and simply crossed them out (+like this+) for posterity. - -#+end_quote - -** Planning Data Flows & Security -:PROPERTIES: -:CUSTOM_ID: planning-data-flows-security -:END: -*** My Personal Data Flow -:PROPERTIES: -:CUSTOM_ID: my-personal-data-flow -:END: -#+begin_src txt - ┌───────┐ ┌─────────────────┐ - ┌──► VLAN1 ├───► Private Devices │ - │ └───────┘ └─────────────────┘ -┌──────────┐ ┌────────┐ ┌──────────┐ ┌────────┐ │ -│ Internet ├───► Router ├───► Firewall ├───► Switch ├──┤ -└──────────┘ └────────┘ └──────────┘ └────────┘ │ - │ ┌───────┐ ┌───────────────┐ - └──► VLAN2 ├───► Public Server │ - └───────┘ └───────────────┘ -#+end_src - -*** Thought Process -:PROPERTIES: -:CUSTOM_ID: thought-process -:END: -To serve content from your home server and harden your security posture, -you have to think about the transport of data from =server= to =client=. - -Let's start with the actual server itself. Think about the following: - -- Do I have a firewall enabled? Do I need to update this to allow new - ports or IPs? -- Do I have an IPS/IDS that may prevent outside traffic? -- Do I have any other security software installed? -- Are the services hosted inside Docker containers, behind a reverse - proxy, or virtualized? If so, are they configured to allow outside - traffic? - -Once the data leaves the server, where does it go? In my case, it goes -to a managed switch. In this case, I asked the following: - -- What configurations is the switch using? -- Am I using VLANs? - - Yes, I am using 802.1Q VLANs. -- Are the VLANs configured properly? - - Yes, as shown in the [[#switch][Switch]] section below, I have a - separate VLAN to allow outside traffic to and from the server alone. - No other devices, except for a service port, and in that VLAN. - -At this point, the data has been processed through the switch. Where -does it go next? In my case, it's pretty simple: it goes to the -router/modem device. - -- Does my ISP block any ports that I need? - - This is an important step that a lot of people run into when - self-hosting at home. Use an online port-checker tool for your IP or - call your ISP if you think ports are blocked. -- Is there a router firewall? - - Yes, I checked that it's configured to allow the ports I need to run - my services publicly. Common web servers and reverse proxies require - ports 80 and 443, but other services like media servers or games can - require unique ports, so be sure to check the documentation for your - service(s). -- Are there any other settings affecting inbound/outbound traffic? - - Schedules or access blocks - - Static Routing - - QoS - - Port Forwarding - - DMZ Hosting - - Remote Management (this can sometimes mess with services that also - require the use of ports 80 and 443) - -Once the data leaves my router, it goes to the upstream ISP and can be -accessed publicly. - -** Server -:PROPERTIES: -:CUSTOM_ID: server -:END: -+The services I run on my server are installed straight into the OS, -without any use of Docker or VMs, so I don't need any extra application -configuration to make them accessible to the outside world.+ - -As of 2022-10-04, the paragraph above is no longer true as I now run a -reverse proxy with Nginx and host many services inside Docker. However, -it doesn't change anything regarding this post as I still just need to -open ports 80 & 443 and create the necessary website configuration -files. - -When creating new services - either installed directly on bare metal or -within something like Docker - I ensure that I read through the -documentation thoroughly to understand a few key things: - What network -activities should this app perform (if any)? Using which ports and -protocols? - Does this app require any commands/services to be run as -=root=? - Does this app log errors, authentication failures/successes, -or anything else that would be useful for an investigation? - -For extra security, I use limit all incoming connections to SSH -connections through my server firewall (=ufw=) and disable common SSH -settings. After all of that, I use =fail2ban= as a preventative measure -against brute-force login attempts. - -As another piece of security, you can randomize your SSH port to ensure -that random scanners or attackers can't easily try to force their way -into your network. For example, you can edit the port rules in your -server to block all connection requests to port =22= but forward all -remote connections from port =12345= to your server's port =22=. Then -you just need to SSH to your network via your randomized port. - -*** =ufw= -:PROPERTIES: -:CUSTOM_ID: ufw -:END: -To see how to configure =ufw=, see my other post: -[[/blog/secure-your-network-with-the-uncomplicated-firewall/][Secure -Your Network with the Uncomplicated Firewall]]. - -The general notion with an on-device firewall is that you want to deny -all incoming connections by default and then selectively open certain -ports for services or users that you know need access. - -If you know that you will only be logging into this server from a -certain set or list of IPs, you can always set the firewall to only -allow connections to port 22 from those IPs. - -For a quick start to only allow SSH connections to the server, use this: - -#+begin_src sh -sudo ufw default deny incoming -sudo ufw default allow outgoing -sudo ufw allow 22 -sudo ufw enable -#+end_src - -#+caption: ufw -[[https://img.cleberg.net/blog/20220324-hardening-a-public-facing-home-server/ufw.png]] - -*** =ssh= -:PROPERTIES: -:CUSTOM_ID: ssh -:END: -**** Using SSH Keys -:PROPERTIES: -:CUSTOM_ID: using-ssh-keys -:END: -First, make sure you have an SSH keypair generated on the device(s) that -you'll be using to log in to the server. If you don't have an SSH key, -run this command: - -#+begin_src sh -ssh-keygen -#+end_src - -Now that we have an SSH key, copy it to the server with the following -command, which will ask for the user's password before accepting the -key: - -#+begin_src sh -ssh-copy-id my_user@my_server -#+end_src - -If you have multiple keys, you'll need to specify which to use. After -it's complete, =ssh= back into the server as that user and make sure it -doesn't ask for a password. - -**** Disable Password & Root Authentication -:PROPERTIES: -:CUSTOM_ID: disable-password-root-authentication -:END: -Now that we can access the server without a password, we will disable -password authentication and disable anyone from using =ssh= to login as -=root=. - -To do this, open the =sshd_config= file: - -#+begin_src sh -sudo nano /etc/ssh/sshd_config -#+end_src - -You'll need to update the parameters to the values below. If one of -these rules is commented-out or doesn't exist, create the rule at the -bottom of the file. - -#+begin_src config -PermitRootLogin no -PasswordAuthentication no -PubkeyAuthentication yes -#+end_src - -Finally, restart the =ssh= service: - -#+begin_src sh -sudo systemctl restart sshd.service -#+end_src - -To test that everything's working so far, open ANOTHER terminal and try -logging in as =root= over SSH. It is very important that you keep your -current SSH session open and test with an additional session, or you -will lock yourself out at some point and will need to use a recovery -method (e.g., hooking monitor up to home server) to get yourself back -in. - -**** Enable MFA for =ssh= -:PROPERTIES: -:CUSTOM_ID: enable-mfa-for-ssh -:END: -This part is optional, but I highly recommend it. So far, we've ensured -that no one can log into our user on the server without using our secret -key, and we've ensured that no one can log in remotely as =root=. Next, -you can enable MFA authentication for =ssh= connections. - -This process involves editing a couple files and installing an MFA -package, so I will not include all the details in this post. To see how -to configure MFA for =ssh=, see my other post: -[[/blog/enable-totp-mfa-for-ssh/][Enabling MFA for SSH]]. - -#+caption: SSH MFA -[[https://img.cleberg.net/blog/20220324-hardening-a-public-facing-home-server/ssh_mfa.png]] - -*** =fail2ban= -:PROPERTIES: -:CUSTOM_ID: fail2ban -:END: -I haven't written a post on how I use =fail2ban=, but it's quite simple. -I use the default =sshd= jail, but you can always create new jails for -respective applications or ports. For example, if you use Nginx as your -web server, you can use the =nginx-http-auth= jail. - -In order to get it up and running, use the following commands: - -#+begin_src sh -sudo apt install fail2ban -sudo fail2ban-client start sshd -sudo fail2ban-client status sshd -#+end_src - -This should be used as a last-resort defense and shouldn't be a -replacement for the security measures mentioned above. - -#+caption: fail2ban -[[https://img.cleberg.net/blog/20220324-hardening-a-public-facing-home-server/fail2ban.png]] - -** Switch -:PROPERTIES: -:CUSTOM_ID: switch -:END: -Between the router and any local devices is my managed switch, which is -used to create VLANs. The example below shows how I would isolate the -VLANs if I were starting to host a single service at home. - -*** 802.1Q VLAN Configuration -:PROPERTIES: -:CUSTOM_ID: q-vlan-configuration -:END: -In this configuration, port 8 is the public server that needs to be -accessed from the outside. Port 23 is my 'dedicated service port' for -this server. In order to SSH to this server, I need to plug my laptop -into port 23 or else I cannot SSH. Otherwise, I'd need to hook up a -monitor and keyboard directly to the server to manage it. - -| VLAN ID | VLAN Name | Member Ports | Tagged Ports | Untagged Ports | -|---------+-----------+--------------+--------------+----------------| -| 1 | Default | 1-24 | | 1-24 | -| 2 | Server | 1,8,23 | | 1,8,23 | - -*** 802.1Q VLAN PVID Setting -:PROPERTIES: -:CUSTOM_ID: q-vlan-pvid-setting -:END: -Once the VLAN is created, I simply add the =VLAN ID= of =2= as the -=PVID= for any related ports (in this case, see that ports =8= and =23= -have a PVID of =2=). - -| Port | PVID | -|------+------| -| 1 | 1 | -| 2 | 1 | -| 3 | 1 | -| 4 | 1 | -| 5 | 1 | -| 6 | 1 | -| 7 | 1 | -| 8 | 2 | -| 9 | 1 | -| 10 | 1 | -| 11 | 1 | -| 12 | 1 | -| 13 | 1 | -| 14 | 1 | -| 15 | 1 | -| 16 | 1 | -| 17 | 1 | -| 18 | 1 | -| 19 | 1 | -| 20 | 1 | -| 21 | 1 | -| 22 | 1 | -| 23 | 2 | -| 24 | 1 | - -** Router -:PROPERTIES: -:CUSTOM_ID: router -:END: -On my router, the configuration was as easy as opening the firewall -settings and unblocking the ports I needed for my services (e.g., -HTTP/S, Plex, SSH, MySQL, etc.). - -+Since I'm relying on an ISP-provided modem/router combo for now (not by -choice), I do not use any other advanced settings on my router that -would inhibit any valid traffic to these services.+ - -The paragraph above regarding the ISP-owned router is no longer accurate -as I now use the Ubiquiti Unifi Dream Machine Pro as my router. Within -this router, I enabled port forwarding/firewall rules, segregate the -network based on the device, and enable traffic restrictions (e.g., -silently drop traffic from certain countries and threat categories). - -If you have the option with your ISP, I recommend using a personal -router with software that you are familiar with so that you can explore -all the options available to you. - -** Physical Security -:PROPERTIES: -:CUSTOM_ID: physical-security -:END: -One large piece of self-hosting that people generally don't discuss -online is physical security. However, physical security is very -important for everyone who hosts a server like this. Exactly /how/ -important it is depends on the server use/purpose. - -If you self-host customer applications that hold protected data (HIPAA, -GDPR, COPPA, etc.), then physical security is extremely important and -cannot be ignored. If you simply host a blog and some hobby sites, then -it's a relatively minor consideration, but one you still need to think -about. - -*** Location -:PROPERTIES: -:CUSTOM_ID: location -:END: -The first consideration is quite simple: location. - Is the server -within a property you own or housed on someone else's property? - Is it -nearby (in your house, in your work office, in your neighbor's garage, -in a storage unit, etc.)? - Do you have 24/7 access to the server? - Are -there climate considerations, such as humidity, fires, tornadoes, -monsoons? - Do you have emergency equipment nearby in case of emergency? - -*** Hardware Ownership -:PROPERTIES: -:CUSTOM_ID: hardware-ownership -:END: -Secondly, consider the hardware itself: - Do you own the server in its -entirety? - Are any other users able to access the server, even if your -data/space is segregated? - If you're utilizing a third party, do they -have any documentation to show responsibility? This could be a SOC 1/2/3 -report, ISO compliance report, internal security/safety documentation. - -*** Physical Controls -:PROPERTIES: -:CUSTOM_ID: physical-controls -:END: -Regardless of who owns the hardware, ensure that there are adequate -safeguards in place, if necessary. These usually don't apply to small -home servers and are usually covered already if you're utilizing a third -party. - -These can include: - Server bezel locks - Server room locks - physical, -digital, or biometric authentication - Security cameras - Raised -floors/lowered ceilings with proper guards/gates in-place within the -floors or ceilings - Security personnel - Log sheets and/or guest badges diff --git a/blog/2022-04-02-nginx-reverse-proxy.org b/blog/2022-04-02-nginx-reverse-proxy.org deleted file mode 100644 index fc023a5..0000000 --- a/blog/2022-04-02-nginx-reverse-proxy.org +++ /dev/null @@ -1,247 +0,0 @@ -#+title: Set-Up a Reverse Proxy with Nginx -#+date: 2022-04-02 - -** What is a Reverse Proxy? -:PROPERTIES: -:CUSTOM_ID: what-is-a-reverse-proxy -:END: -A reverse proxy is a server that is placed between local servers or -services and clients/users (e.g., the internet). The reverse proxy -intercepts all requests from clients at the network edge and uses its -configuration files to determine where each request should be sent. - -*** A Brief Example -:PROPERTIES: -:CUSTOM_ID: a-brief-example -:END: -For example, let's say that I run three servers in my home: - -- Server_01 (=example.com=) -- Server_02 (=service01.example.com=) -- Server_03 (=service02.example.com=) - -I also run a reverse proxy in my home that intercepts all public -traffic: - -- Reverse Proxy - -Assume that I have a domain name (=example.com=) that allows clients to -request websites or services from my home servers. - -In this case, the reverse proxy will intercept all traffic from -=example.com= that enters my network and determine if the client is -requesting valid data, based on my configuration. - -If the user is requesting =example.com= and my configuration files say -that Server_01 holds that data, Nginx will send the user to Server_01. -If I were to change the configuration so that =example.com= is routed to -Server_02, that same user would be sent to Server_02 instead. - -#+begin_src txt -┌──────┐ ┌───────────┐ -│ User │─┐ ┌──► Server_01 │ -└──────┘ │ │ └───────────┘ - │ ┌──────────┐ ┌───────────────┐ │ ┌───────────┐ - ├────► Internet ├───► Reverse Proxy ├─────├──► Server_02 │ - │ └──────────┘ └───────────────┘ │ └───────────┘ -┌──────┐ │ │ ┌───────────┐ -│ User │─┘ └──► Server_03 │ -└──────┘ └───────────┘ -#+end_src - -** Reverse Proxy Options -:PROPERTIES: -:CUSTOM_ID: reverse-proxy-options -:END: -There are a lot of options when it comes to reverse proxy servers, so -I'm just going to list a few of the options I've heard recommended over -the last few years: - -- [[https://nginx.com][Nginx]] -- [[https://caddyserver.com][Caddy]] -- [[https://traefik.io/][Traefik]] -- [[https://www.haproxy.org/][HAProxy]] -- [[https://ubuntu.com/server/docs/proxy-servers-squid][Squid]] - -In this post, we will be using Nginx as our reverse proxy, running on -Ubuntu Server 20.04.4 LTS. - -** Nginx Reverse Proxy Example -:PROPERTIES: -:CUSTOM_ID: nginx-reverse-proxy-example -:END: -*** Local Applications -:PROPERTIES: -:CUSTOM_ID: local-applications -:END: -You may be like me and have a lot of applications running on your local -network that you'd like to expose publicly with a domain. - -In my case, I have services running in multiple Docker containers within -a single server and want a way to visit those services from anywhere -with a URL. For example, on my local network, -[[https://dashy.to][Dashy]] runs through port 4000 (=localhost:4000=) -and [[https://github.com/louislam/uptime-kuma][Uptime Kuma]] runs -through port 3001 (=localhost:3001=). - -In order to expose these services to the public, I will need to do the -following: - -1. Set up DNS records for a domain or subdomain (one per service) to - point toward the IP address of the server. -2. Open up the server network's HTTP and HTTPS ports (80 & 443) so that - the reverse proxy can accept traffic and determine where to send it. -3. Install the reverse proxy software. -4. Configure the reverse proxy to recognize which service should get - traffic from any of the domains or subdomains. - -*** Step 1: DNS Configuration -:PROPERTIES: -:CUSTOM_ID: step-1-dns-configuration -:END: -To start, update your DNS configuration so that you have an =A= record -for each domain or subdomain. - -The =A= records should point toward the public IP address of the server. -If you don't know the public IP address, log in to the server and run -the following command: - -#+begin_src sh -curl ifconfig.co -#+end_src - -In the DNS example below, =xxx.xxx.xxx.xxx= is the public IP address of -the server. - -#+begin_src config -example.com A xxx.xxx.xxx.xxx -uptime.example.com A xxx.xxx.xxx.xxx -dashy.example.com A xxx.xxx.xxx.xxx -www CNAME example.com -#+end_src - -Finally, ensure the DNS has propagated correctly with -[[https://dnschecker.org][DNS Checker]] by entering your domains or -subdomains in the search box and ensuring the results are showing the -correct IP address. - -*** Step 2: Open Network Ports -:PROPERTIES: -:CUSTOM_ID: step-2-open-network-ports -:END: -This step will be different depending on which router you have in your -home. If you're not sure, try to visit -[[http://192.168.1.1][192.168.1.1]] in your browser. Login credentials -are usually written on a sticker somewhere on your modem/router. - -Once you're able to log in to your router, find the Port Forwarding -settings. You will need to forward ports =80= and =443= to whichever -machine is running the reverse proxy. - -In my case, the table below shows the port-forwarding rules I've -created. In this table, =xxx.xxx.xxx.xxx= is the local device IP of the -reverse proxy server, it will probably be an IP between =192.168.1.1= -and =192.168.1.255=. - -| NAME | FROM | PORT | DEST PORT/IP | ENABLED | -|-------+------+------+-----------------+---------| -| HTTP | * | 80 | xxx.xxx.xxx.xxx | TRUE | -| HTTPS | * | 443 | xxx.xxx.xxx.xxx | TRUE | - -Once configured, these rules will direct all web traffic to your reverse -proxy. - -*** Step 3: Nginx Installation -:PROPERTIES: -:CUSTOM_ID: step-3-nginx-installation -:END: -To install Nginx, simply run the following command: - -#+begin_src sh -sudo apt install nginx -#+end_src - -If you have a firewall enabled, open up ports =80= and =443= on your -server so that Nginx can accept web traffic from the router. - -For example, if you want to use =ufw= for web traffic and SSH, run the -following commands: - -#+begin_src sh -sudo ufw allow 'Nginx Full' -sudo ufw allow SSH -sudo ufw enable -#+end_src - -*** Step 4: Nginx Configuration -:PROPERTIES: -:CUSTOM_ID: step-4-nginx-configuration -:END: -Now that we have domains pointing toward the server, the only step left -is to configure the reverse proxy to direct traffic from domains to -local services. - -To start, you'll need to create a configuration file for each domain in -=/etc/nginx/sites-available/=. They will look identical except for the -=server_name= variable and the =proxy_pass= port. - -Dashy: - -#+begin_src sh -nano /etc/nginx/sites-available/dashy.example.com -#+end_src - -#+begin_src config -server { - listen 80; - server_name dashy.example.com; - - location / { - proxy_pass http://localhost:4000; - } -} -#+end_src - -Uptime: - -#+begin_src sh -nano /etc/nginx/sites-available/uptime.example.com -#+end_src - -#+begin_src config -server { - listen 80; - server_name uptime.example.com; - - location / { - proxy_pass http://localhost:3001; - } -} -#+end_src - -Once the configuration files are created, you will need to enable them -with the =symlink= command: - -#+begin_src sh -sudo ln -s /etc/nginx/sites-available/dashy.example.com /etc/nginx/sites-enabled/ -#+end_src - -Voilà! Your local services should now be available through their URLs. - -** HTTPS with Certbot -:PROPERTIES: -:CUSTOM_ID: https-with-certbot -:END: -If you've followed along, you'll notice that your services are only -available via HTTP (not HTTPS). - -If you want to enable HTTPS for your new domains, you will need to -generate SSL/TLS certificates for them. The easiest way to generate -certificates on Nginx is [[https://certbot.eff.org][Certbot]]: - -#+begin_src sh -sudo apt install snapd; sudo snap install core; sudo snap refresh core -sudo snap install --classic certbot -sudo ln -s /snap/bin/certbot /usr/bin/certbot -sudo certbot --nginx -#+end_src diff --git a/blog/2022-06-24-fedora-i3.org b/blog/2022-06-24-fedora-i3.org deleted file mode 100644 index af02902..0000000 --- a/blog/2022-06-24-fedora-i3.org +++ /dev/null @@ -1,170 +0,0 @@ -#+title: Rebooting My Love Affair with Linux -#+date: 2022-06-24 - -** Leaving macOS -:PROPERTIES: -:CUSTOM_ID: leaving-macos -:END: -As I noted [[/blog/foss-macos-apps][in a recent post]], I have been -planning on migrating from macOS back to a Linux-based OS. I am happy to -say that I have finally completed my migration and am now stuck in the -wonderful world of Linux again. - -My decision to leave macOS really came down to just a few important -things: - -- Apple Security (Gatekeeper) restricting me from running any software I - want. Even if you disable Gatekeeper and allow software to bypass the - rest of the device installation security, you still have to repeat - that process every time the allowed software is updated. -- macOS sends out nearly constant connections, pings, telemetry, etc. to - a myriad of mysterious Apple services. I'm not even going to dive into - how many macOS apps have constant telemetry on, as well. -- Lastly, I just /really/ missed the customization and freedom that - comes with Linux. Being able to switch to entirely new kernel, OS, or - desktop within minutes is a freedom I took for granted when I switched - to macOS. - -Now that I've covered macOS, I'm going to move on to more exciting -topics: my personal choice of OS, DE, and various customizations I'm -using. - -** Fedora -:PROPERTIES: -:CUSTOM_ID: fedora -:END: -After trying a ton of distros (I think I booted and tested around 20-25 -distros), I finally landed on [[https://getfedora.org/][Fedora Linux]]. -I have quite a bit of experience with Fedora and enjoy the =dnf= package -manager. Fedora allows me to keep up-to-date with recent software (I'm -looking at you, Debian), but still provides a level of stability you -don't find in every distro. - -In a very close second place was Arch Linux, as well as its spin-off: -Garuda Linux (Garuda w/ sway is /beautiful/). Arch is great for -compatibility and the massive community it has, but I have just never -had the time to properly sit down and learn the methodology behind their -packaging systems. - -Basically, everything else I tested was unacceptable in at least one way -or another. Void (=glibc=) was great, but doesn't support all the -software I need. Slackware worked well as a tui, but I wasn't skilled -enough to get a tiling window manager (WM) working on it. - -*** i3 -:PROPERTIES: -:CUSTOM_ID: i3 -:END: -One of the reasons I settled on Fedora is that it comes with an official -i3 spin. Being able to use a tiling WM, such as i3 or sway, is one of -the biggest things I wanted to do as soon as I adopted Linux again. - -I will probably set up a dotfile repository soon, so that I don't lose -any of my configurations, but nothing big has been configured thus far. - -The two main things I have updated in i3wm are natural scrolling and -binding my brightness keys to the =brightnessctl= program. - -**** Natural Scrolling -:PROPERTIES: -:CUSTOM_ID: natural-scrolling -:END: -You can enable natural scrolling by opening the following file: - -#+begin_src sh -sudo nano /usr/share/X11/xorg.conf.d/40-libinput.conf -#+end_src - -Within the =40-libinput.conf= file, find the following input sections -and enable the natural scrolling option. - -This is the =pointer= section: - -#+begin_src conf -Section "InputClass" - Identifier "libinput pointer catchall" - MatchIsPointer "on" - MatchDevicePath "/dev/input/event*" - Driver "libinput" - Option "NaturalScrolling" "True" -EndSection -#+end_src - -This is the =touchpad= section: - -#+begin_src conf -Section "InputClass" - Identifier "libinput touchpad catchall" - MatchIsTouchpad "on" - MatchDevicePath "/dev/input/event*" - Driver "libinput" - Option "NaturalScrolling" "True" -EndSection -#+end_src - -**** Enabling Brightness Keys -:PROPERTIES: -:CUSTOM_ID: enabling-brightness-keys -:END: -Likewise, enabling brightness key functionality is as simple as binding -the keys to the =brightnessctl= program. - -To do this, open up your i3 config file. Mine is located here: - -#+begin_src sh -nano /home/<my-user>/.config/i3/config -#+end_src - -#+begin_src conf -# Use brightnessctl to adjust brightness. -bindsym XF86MonBrightnessDown exec --no-startup-id brightnessctl --min-val=2 -q set 3%- -bindsym XF86MonBrightnessUp exec --no-startup-id brightnessctl -q set 3%+ -#+end_src - -**** =polybar= -:PROPERTIES: -:CUSTOM_ID: polybar -:END: -Instead of using the default =i3status= bar, I have opted to use -=polybar= instead (as you can also see in the screenshot above). - -My config for this menu bar is basically just the default settings with -modified colors and an added battery block to quickly show me the -machine's battery info. - -**** =alacritty= -:PROPERTIES: -:CUSTOM_ID: alacritty -:END: -Not much to say on this part yet, as I haven't configured it much, but I -installed =alacritty= as my default terminal, and I am using =zsh= and -the shell. - -** Software Choices -:PROPERTIES: -:CUSTOM_ID: software-choices -:END: -Again, I'm not going to say much that I haven't said yet in other blog -posts, so I'll just do a quick rundown of the apps I installed -immediately after I set up the environment. - -Flatpak Apps: - -- Cryptomator -- pCloud -- Signal - -Fedora Packages: - -- gomuks -- neomutt -- neofetch -- Firefox - - uBlock Origin - - Bitwarden - - Stylus - - Privacy Redirect - -Other: - -- exiftool diff --git a/blog/2022-07-01-git-server.org b/blog/2022-07-01-git-server.org deleted file mode 100644 index 049603e..0000000 --- a/blog/2022-07-01-git-server.org +++ /dev/null @@ -1,678 +0,0 @@ -#+title: Self-Hosting a Personal Git Server -#+date: 2022-07-01 - -** My Approach to Self-Hosting Git -:PROPERTIES: -:CUSTOM_ID: my-approach-to-self-hosting-git -:END: -I have often tried to self-host my Git repositories, but have always -fallen short when I tried to find a suitable web interface to show on -the front-end. - -After a few years, I have finally found a combination of methods that -allow me to easily self-host my projects, view them on the web, and -access them from anywhere. - -Before I dive into the details, I want to state a high-level summary of -my self-hosted Git approach: - -- This method uses the =ssh://= (read & write) and =git://= (read-only) - protocols for push and pull access. - - For the =git://= protocol, I create a =git-daemon-export-ok= file in - any repository that I want to be cloneable by anyone. - - The web interface I am using (=cgit=) allows simple HTTP cloning by - default. I do not disable this setting as I want beginners to be - able to clone one of my repositories even if they don't know the - proper method. -- I am not enabling Smart HTTPS for any repositories. Updates to - repositories must be pushed via SSH. -- Beyond the actual repository management, I am using =cgit= for the - front-end web interface. - - If you use the =scan-path=<path>= configuration in the =cgitrc= - configuration file to automatically find repositories, you can't - exclude a repository from =cgit= if it's stored within the path that - =cgit= reads. To host private repositories, you'd need to set up - another directory that =cgit= can't read. - -** Assumptions -:PROPERTIES: -:CUSTOM_ID: assumptions -:END: -For the purposes of this walkthrough, I am assuming you have a URL -(=git.example.com=) or IP address (=207.84.26.991=) addressed to the -server that you will be using to host your git repositories. - -** Adding a Git User -:PROPERTIES: -:CUSTOM_ID: adding-a-git-user -:END: -In order to use the SSH method associated with git, we will need to add -a user named =git=. If you have used the SSH method for other git -hosting sites, you are probably used to the following syntax: - -#+begin_src sh -git clone [user@]server:project.git -#+end_src - -The syntax above is an =scp=-like syntax for using SSH on the =git= user -on the server to access your repository. - -Let's delete any remnants of an old =git= user, if any, and create the -new user account: - -#+begin_src sh -sudo deluser --remove-home git -sudo adduser git -#+end_src - -*** Import Your SSH Keys to the Git User -:PROPERTIES: -:CUSTOM_ID: import-your-ssh-keys-to-the-git-user -:END: -Once the =git= user is created, you will need to copy your public SSH -key on your local development machine to the =git= user on the server. - -If you don't have an SSH key yet, create one with this command: - -#+begin_src sh -ssh-keygen -#+end_src - -Once you create the key pair, the public should be saved to -=~/.ssh/id_rsa.pub=. - -If your server still has password-based authentication available, you -can copy it over to your user's home directory like this: - -#+begin_src sh -ssh-copy-id git@server -#+end_src - -Otherwise, copy it over to any user that you can access. - -#+begin_src sh -scp ~/.ssh/id_rsa.pub your_user@your_server: -#+end_src - -Once on the server, you will need to copy the contents into the =git= -user's =authorized_keys= file: - -#+begin_src sh -cat id_rsa.pub > /home/git/.ssh/authorized_keys -#+end_src - -*** (Optional) Disable Password-Based SSH -:PROPERTIES: -:CUSTOM_ID: optional-disable-password-based-ssh -:END: -If you want to lock down your server and ensure that no one can -authenticate in via SSH with a password, you will need to edit your SSH -configuration. - -#+begin_src sh -sudo nano /etc/ssh/sshd_config -#+end_src - -Within this file, find the following settings and set them to the values -I am showing below: - -#+begin_src conf -PermitRootLogin no -PasswordAuthentication no -AuthenticationMethods publickey -#+end_src - -You may have other Authentication Methods required in your personal -set-up, so the key here is just to ensure that =AuthenticationMethods= -does not allow passwords. - -** Setting up the Base Directory -:PROPERTIES: -:CUSTOM_ID: setting-up-the-base-directory -:END: -Now that we have set up a =git= user to handle all transport methods, we -need to set up the directory that we will be using as our base of all -repositories. - -In my case, I am using =/git= as my source folder. To create this folder -and assign it to the user we created, execute the following commands: - -#+begin_src sh -sudo mkdir /git -sudo chown -R git:git /git -#+end_src - -** Creating a Test Repository -:PROPERTIES: -:CUSTOM_ID: creating-a-test-repository -:END: -On your server, switch over to the =git= user in order to start managing -git files. - -#+begin_src sh -su git -#+end_src - -Once logged-in as the =git= user, go to your base directory and create a -test repository. - -#+begin_src sh -cd /git -mkdir test.git && cd test.git -git init --bare -#+end_src - -If you want to make this repo viewable/cloneable to the public via the -=git://= protocol, you need to create a =git-daemon-export-ok= file -inside the repository. - -#+begin_src sh -touch git-daemon-export-ok -#+end_src - -** Change the Login Shell for =git= -:PROPERTIES: -:CUSTOM_ID: change-the-login-shell-for-git -:END: -To make sure that the =git= user is only used for git operations and -nothing else, you need to change the user's login shell. To do this, -simply use the =chsh= command: - -#+begin_src sh -sudo chsh git -#+end_src - -The interactive prompt will ask which shell you want the =git= user to -use. You must use the following value: - -#+begin_src sh -/usr/bin/git-shell -#+end_src - -Once done, no one will be able to SSH to the =git= user or execute -commands other than the standard git commands. - -** Opening the Firewall -:PROPERTIES: -:CUSTOM_ID: opening-the-firewall -:END: -Don't forget to open up ports on the device firewall and network -firewall if you want to access these repositories publicly. If you're -using default ports, forward ports =22= (ssh) and =9418= (git) from your -router to your server's IP address. - -If your server also has a firewall, ensure that the firewall allows the -same ports that are forwarded from the router. For example, if you use -=ufw=: - -#+begin_src sh -sudo ufw allow 22 -sudo ufw allow 9418 -#+end_src - -*** Non-Standard SSH Ports -:PROPERTIES: -:CUSTOM_ID: non-standard-ssh-ports -:END: -If you use a non-standard port for SSH, such as =9876=, you will need to -create an SSH configuration file on your local development machine in -order to connect to your server's git repositories. - -To do this, you'll need to define your custom port on your client -machine in your =~/.ssh/config= file: - -#+begin_src sh -nano ~/.ssh/config -#+end_src - -#+begin_src conf -Host git.example.com - # HostName can be a URL or an IP address - HostName git.example.com - Port 9876 - User git -#+end_src - -*** Testing SSH -:PROPERTIES: -:CUSTOM_ID: testing-ssh -:END: -There are two main syntaxes you can use to manage git over SSH: - -- =git clone [user@]server:project.git= -- =git clone ssh://[user@]server/project.git= - -I prefer the first, which is an =scp=-like syntax. To test it, try to -clone the test repository you set up on the server: - -#+begin_src sh -git clone git@git.example.com:/git/test.git -#+end_src - -** Enabling Read-Only Access -:PROPERTIES: -:CUSTOM_ID: enabling-read-only-access -:END: -If you want people to be able to clone any repository where you've -placed a =git-daemon-export-ok= file, you will need to start the git -daemon. - -To do this on a system with =systemd=, create a service file: - -#+begin_src sh -sudo nano /etc/systemd/system/git-daemon.service -#+end_src - -Inside the =git-daemon.service= file, paste the following: - -#+begin_src conf -[Unit] -Description=Start Git Daemon - -[Service] -ExecStart=/usr/bin/git daemon --reuseaddr --base-path=/git/ /git/ - -Restart=always -RestartSec=500ms - -StandardOutput=syslog -StandardError=syslog -SyslogIdentifier=git-daemon - -User=git -Group=git - -[Install] -WantedBy=multi-user.target -#+end_src - -Once created, enable and start the service: - -#+begin_src sh -sudo systemctl enable git-daemon.service -sudo systemctl start git-daemon.service -#+end_src - -To clone read-only via the =git://= protocol, you can use the following -syntax: - -#+begin_src sh -git clone git://git.example.com/test.git -#+end_src - -** Migrating Repositories -:PROPERTIES: -:CUSTOM_ID: migrating-repositories -:END: -At this point, we have a working git server that works with both SSH and -read-only access. - -For each of the repositories I had hosted a different provider, I -executed the following commands in order to place a copy on my server as -my new source of truth: - -Server: - -#+begin_src sh -su git -mkdir /git/<REPOSITORY_NAME>.git && cd /git/<REPOSITORY_NAME>.git -git init --bare - -# If you want to make this repo viewable/cloneable to the public -touch git-daemon-export-ok -#+end_src - -Client: - -#+begin_src sh -git clone git@<PREVIOUS_HOST>:<REPOSITORY_NAME> -git remote set-url origin git@git.EXAMPLE.COM:/git/<REPOSITORY_NAME>.git -git push -#+end_src - -** Optional Web View: =cgit= -:PROPERTIES: -:CUSTOM_ID: optional-web-view-cgit -:END: -If you want a web viewer for your repositories, you can use various -tools, such as =gitweb=, =cgit=, or =klaus=. I chose =cgit= due to its -simple interface and fairly easy set-up (compared to others). Not to -mention that the [[https://git.kernel.org/][Linux kernel uses =cgit=]]. - -*** Docker Compose -:PROPERTIES: -:CUSTOM_ID: docker-compose -:END: -Instead of using my previous method of using a =docker run= command, -I've updated this section to use =docker-compose= instead for an easier -installation and simpler management and configuration. - -In order to use Docker Compose, you will set up a =docker-compose.yml= -file to automatically connect resources like the repositories, =cgitrc=, -and various files or folders to the =cgit= container you're creating: - -#+begin_src sh -mkdir ~/cgit && cd ~/cgit -nano docker-compose.yml -#+end_src - -#+begin_src conf -# docker-compose.yml -version: '3' - -services: - cgit: - image: invokr/cgit - volumes: - - /git:/git - - ./cgitrc:/etc/cgitrc - - ./logo.png:/var/www/htdocs/cgit/logo.png - - ./favicon.png:/var/www/htdocs/cgit/favicon.png - - ./filters:/var/www/htdocs/cgit/filters - ports: - - "8763:80" - restart: always -#+end_src - -Then, just start the container: - -#+begin_src sh -sudo docker-compose up -d -#+end_src - -Once it's finished installing, you can access the site at -=<SERVER_IP>:8763= or use a reverse-proxy service to forward =cgit= to a -URL, such as =git.example.com=. See the next section for more details on -reverse proxying a URL to a local port. - -*** Nginx Reverse Proxy -:PROPERTIES: -:CUSTOM_ID: nginx-reverse-proxy -:END: -I am using Nginx as my reverse proxy so that the =cgit= Docker container -can use =git.example.com= as its URL. To do so, I simply created the -following configuration file: - -#+begin_src sh -sudo nano /etc/nginx/sites-available/git.example.com -#+end_src - -#+begin_src conf -server { - listen 80; - server_name git.example.com; - - if ($host = git.example.com) { - return 301 https://$host$request_uri; - } - - return 404; -} - -server { - server_name git.example.com; - listen 443 ssl http2; - - location / { - # The final `/` is important. - proxy_pass http://localhost:8763/; - add_header X-Frame-Options SAMEORIGIN; - add_header X-XSS-Protection "1; mode=block"; - proxy_redirect off; - proxy_buffering off; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Port $server_port; - } - - # INCLUDE ANY SSL CERTS HERE - include /etc/letsencrypt/options-ssl-nginx.conf; - ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; -} -#+end_src - -Once created, symlink it and restart the web server. - -#+begin_src sh -sudo ln -s /etc/nginx/sites-available/git.example.com /etc/nginx/sites-enabled/ -sudo systemctl restart nginx.service -#+end_src - -As we can see below, my site at =git.example.com= is available and -running: - -*** Settings Up Git Details -:PROPERTIES: -:CUSTOM_ID: settings-up-git-details -:END: -Once you have =cgit= running, you can add some small details, such as -repository owners and descriptions by editing the following files within -each repository. - -Alternatively, you can use the =cgitrc= file to edit these details if -you only care to edit them for the purpose of seeing them on your -website. - -The =description= file within the repository on your server will display -the description online. - -#+begin_src sh -cd /git/example.git -nano description -#+end_src - -You can add a =[gitweb]= block to the =config= file in order to display -the owner of the repository. - -#+begin_src sh -cd /git/example.git -nano config -#+end_src - -#+begin_src conf -[gitweb] - owner = "YourName" -#+end_src - -Note that you can ignore the configuration within each repository and -simply set up this information in the =cgitrc= file, if you want to do -it that way. - -*** Editing =cgit= -:PROPERTIES: -:CUSTOM_ID: editing-cgit -:END: -In order to edit certain items within =cgit=, you need to edit the -=cgitrc= file. - -#+begin_src sh -nano ~/cgit/cgitrc -#+end_src - -Below is an example configuration for =cgitrc=. You can find all the -configuration options within the [configuration manual] -(https://git.zx2c4.com/cgit/plain/cgitrc.5.txt). - -#+begin_src conf -css=/cgit.css -logo=/logo.png -favicon=/favicon.png -robots=noindex, nofollow - -enable-index-links=1 -enable-commit-graph=1 -enable-blame=1 -enable-log-filecount=1 -enable-log-linecount=1 -enable-git-config=1 - -clone-url=git://git.example.com/$CGIT_REPO_URL ssh://git@git.example.com:/git/$CGIT_REPO_URL - -root-title=My Git Website -root-desc=My personal git repositories. - -# Allow download of tar.gz, tar.bz2 and zip-files -snapshots=tar.gz tar.bz2 zip - -## -## List of common mimetypes -## -mimetype.gif=image/gif -mimetype.html=text/html -mimetype.jpg=image/jpeg -mimetype.jpeg=image/jpeg -mimetype.pdf=application/pdf -mimetype.png=image/png -mimetype.svg=image/svg+xml - -# Highlight source code -# source-filter=/var/www/htdocs/cgit/filters/syntax-highlighting.sh -source-filter=/var/www/htdocs/cgit/filters/syntax-highlighting.py - -# Format markdown, restructuredtext, manpages, text files, and html files -# through the right converters -about-filter=/var/www/htdocs/cgit/filters/about-formatting.sh - -## -## Search for these files in the root of the default branch of repositories -## for coming up with the about page: -## -readme=:README.md -readme=:readme.md -readme=:README.mkd -readme=:readme.mkd -readme=:README.rst -readme=:readme.rst -readme=:README.html -readme=:readme.html -readme=:README.htm -readme=:readme.htm -readme=:README.txt -readme=:readme.txt -readme=:README -readme=:readme - -# Repositories - -# Uncomment the following line to scan a path instead of adding repositories manually -# scan-path=/git - -## Test Section -section=git/test-section - -repo.url=test.git -repo.path=/git/test.git -repo.readme=:README.md -repo.owner=John Doe -repo.desc=An example repository! -#+end_src - -*** Final Fixes: Syntax Highlighting & README Rendering -:PROPERTIES: -:CUSTOM_ID: final-fixes-syntax-highlighting-readme-rendering -:END: -After completing my initial install and playing around with it for a few -days, I noticed two issues: - -1. Syntax highlighting did not work when viewing the source code within - a file. -2. The =about= tab within a repository was not rendered to HTML. - -The following process fixes these issues. To start, let's go to the -=cgit= directory where we were editing our configuration file earlier. - -#+begin_src sh -cd ~/cgit -#+end_src - -In here, create two folders that will hold our syntax files: - -#+begin_src sh -mkdir filters && mkdir filters/html-converters && cd filters -#+end_src - -Next, download the default filters: - -#+begin_src sh -curl https://git.zx2c4.com/cgit/plain/filters/about-formatting.sh > about-formatting.sh -chmod 755 about-formatting.sh -curl https://git.zx2c4.com/cgit/plain/filters/syntax-highlighting.py > syntax-highlighting.py -chmod 755 syntax-highlighting.py -#+end_src - -Finally, download the HTML conversion files you need. The example below -downloads the Markdown converter: - -#+begin_src sh -cd html-converters -curl https://git.zx2c4.com/cgit/plain/filters/html-converters/md2html > md2html -chmod 755 md2html -#+end_src - -If you need other filters or html-converters found within -[[https://git.zx2c4.com/cgit/tree/filters][the cgit project files]], -repeat the =curl= and =chmod= process above for whichever files you -need. - -However, formatting will not work quite yet since the Docker cgit -container we're using doesn't have the formatting package installed. You -can install this easily by install Python 3+ and the =pygments= package: - -#+begin_src sh -# Enter the container's command line -sudo docker exec -it cgit bash -#+end_src - -#+begin_src sh -# Install the necessary packages and then exit -yum update -y && \ -yum upgrade -y && \ -yum install python3 python3-pip -y && \ -pip3 install markdown pygments && \ -exit -#+end_src - -*You will need to enter the cgit docker container and re-run these =yum= -commands every time you kill and restart the container!* - -If not done already, we need to add the following variables to our -=cgitrc= file in order for =cgit= to know where our filtering files are: - -#+begin_src conf -# Highlight source code with python pygments-based highlighter -source-filter=/var/www/htdocs/cgit/filters/syntax-highlighting.py - -# Format markdown, restructuredtext, manpages, text files, and html files -# through the right converters -about-filter=/var/www/htdocs/cgit/filters/about-formatting.sh -#+end_src - -Now you should see that syntax highlighting and README rendering to the -=about= tab is fixed. - -*** Theming -:PROPERTIES: -:CUSTOM_ID: theming -:END: -I won't go into much detail in this section, but you can fully theme -your installation of =cgit= since you have access to the =cgit.css= file -in your web root. This is another file you can add as a volume to the -=docker-compose.yml= file if you want to edit this without entering the -container's command line. - -** :warning: Remember to Back Up Your Data! -:PROPERTIES: -:CUSTOM_ID: warning-remember-to-back-up-your-data -:END: -The last thing to note is that running services on your own equipment -means that you're assuming a level of risk that exists regarding data -loss, catastrophes, etc. In order to reduce the impact of any such -occurrence, I suggest backing up your data regularly. - -Backups can be automated via =cron=, by hooking your base directory up -to a cloud provider, or even setting up hooks to push all repository -info to git mirrors on other git hosts. Whatever the method, make sure -that your data doesn't vanish in the event that your drives or servers -fail. diff --git a/blog/2022-07-25-curseradio.org b/blog/2022-07-25-curseradio.org deleted file mode 100644 index 351c4b9..0000000 --- a/blog/2022-07-25-curseradio.org +++ /dev/null @@ -1,114 +0,0 @@ -#+title: CurseRadio: Listening to the Radio on the Command Line -#+date: 2022-07-25 - -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: -While exploring some interesting Linux applications, I stumbled across -[[https://github.com/chronitis/curseradio][curseradio]], a command-line -radio player based on Python. - -This application is fantastic and incredibly easy to install, so I -wanted to dedicate a post today to this app. Let's look at the features -within the app and then walk through the installation process I took to -get =curseradio= working. - -** Features -:PROPERTIES: -:CUSTOM_ID: features -:END: -#+caption: curseradio -[[https://img.cleberg.net/blog/20220725-curseradio/curseradio.png]] - -The radio player itself is quite minimal. As you can see in the -screenshot above, it contains a simple plaintext list of all available -categories, which can be broken down further and further. In addition, -radio shows are available for listening, alongside regular radio -stations. - -For example, the =Sports= > =Pro Basketball= > =Shows= category contains -a number of specific shows related to Professional Basketball. - -Aside from being able to play any of the listed stations/shows, you can -make a channel your favorite by pressing =f=. It will now show up at the -top of the radio player in the =Favourites= category. - -*** Commands/Shortcuts -:PROPERTIES: -:CUSTOM_ID: commandsshortcuts -:END: -| Key(s) | Command | -|------------+---------------------------------| -| ↑, ↓ | navigate | -| PgUp, PgDn | navigate quickly | -| Home, End | to top/bottom | -| Enter | open/close folders, play stream | -| k | stop playing stream | -| q | quit | -| f | toggle favourite | - -** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: -*** Dependencies -:PROPERTIES: -:CUSTOM_ID: dependencies -:END: -Before installing =curseradio=, a handful of system and Python packages -are required. To get started, install =python3=, =pip3=, and =mpv= on -your system. In this example, I'm using Fedora Linux, which uses the -=dnf= package manager. You may need to adjust this if you're using a -different system. - -#+begin_src sh -sudo dnf install python3 pip3 mpv -#+end_src - -Next, use =pip3= to install =requests=, =xdg=, and =lxml=: - -#+begin_src sh -pip3 install requests xdg lxml -#+end_src - -*** Repository Source Installation -:PROPERTIES: -:CUSTOM_ID: repository-source-installation -:END: -Once all the dependencies are installed, we can clone the source code -and enter that directory: - -#+begin_src sh -git clone https://github.com/chronitis/curseradio && cd curseradio -#+end_src - -Once you're within the =curseradio= directory, you can install the -application with the provided =setup.py= script. - -#+begin_src sh -sudo python3 setup.py install -#+end_src - -In my case, I ran into a few errors and needed to create the folders -that curseradio wanted to use for its installation. If you don't get any -errors, you can skip this and run the app. - -#+begin_src sh -sudo mkdir /usr/local/lib/python3.10/ -sudo mkdir /usr/local/lib/python3.10/site-packages/ -#+end_src - -#+begin_src sh -sudo chown -R $USER:$USER /usr/local/lib/python3.10/ -#+end_src - -** Run the Application -:PROPERTIES: -:CUSTOM_ID: run-the-application -:END: -Once fully installed without errors, you can run the application! - -#+begin_src sh -python3 /usr/local/bin/curseradio -#+end_src diff --git a/blog/2022-09-21-graphene-os.org b/blog/2022-09-21-graphene-os.org deleted file mode 100644 index f17f860..0000000 --- a/blog/2022-09-21-graphene-os.org +++ /dev/null @@ -1,186 +0,0 @@ -#+title: Installing Graphene OS on the Pixel 6 Pro -#+date: 2022-09-21 - -** Introduction -:PROPERTIES: -:CUSTOM_ID: introduction -:END: -After using iOS for a couple of years, I finally took the plunge and -purchased a Pixel 6 Pro in order to test and use [GrapheneOS] -(https://grapheneos.org). - -The installation process was rather quick once you have the tools and -files you need. Overall, it can be done in just a few minutes. - -** Gathering Tools & Files -:PROPERTIES: -:CUSTOM_ID: gathering-tools-files -:END: -*** Android Tools -:PROPERTIES: -:CUSTOM_ID: android-tools -:END: -First, in order to interact with the device, we will need the -[[https://developer.android.com/studio/releases/platform-tools.html][Android -platform tools]]. Find the Linux download and save the ZIP folder to -your preferred location. - -Once we've downloaded the files, we will need to unzip them, enter the -directory, and move the necessary executables to a central location, -such as =/usr/bin/=. For this installation, we only need the =fastboot= -and =adb= executables. - -#+begin_src sh -cd ~/Downloads -#+end_src - -#+begin_src sh -unzip platform-tools_r33.0.3-linux.zip -cd platform-tools -sudo mv fastboot /usr/bin/ -sudo mv adb /usr/bin -#+end_src - -*** GrapheneOS Files -:PROPERTIES: -:CUSTOM_ID: grapheneos-files -:END: -Next, we need the [[https://grapheneos.org/releases][GrapheneOS files]] -for our device and model. For example, the Pixel 6 Pro is codenamed -=raven= on the release page. - -Once we have the links, let's download them to our working directory: - -#+begin_src sh -curl -O https://releases.grapheneos.org/factory.pub -curl -0 https://releases.grapheneos.org/raven-factory-2022091400.zip -curl -0 https://releases.grapheneos.org/raven-factory-2022091400.zip.sig -#+end_src - -**** Validate Integrity -:PROPERTIES: -:CUSTOM_ID: validate-integrity -:END: -In order to validate the integrity of the downloaded files, we will need -the =signify= package and Graphene's =factory.pub= file. - -#+begin_src sh -sudo dnf install signify -#+end_src - -#+begin_src sh -curl -O https://releases.grapheneos.org/factory.pub -#+end_src - -Then we can validate the files and ensure that no data was corrupted or -modified before it was saved to our device. - -#+begin_src sh -signify -Cqp factory.pub -x raven-factory-2022091400.zip.sig && echo verified -#+end_src - -**** Unzip Files -:PROPERTIES: -:CUSTOM_ID: unzip-files -:END: -Once the files are verified, we can unzip the Graphene image and enter -the directory: - -#+begin_src sh -unzip raven-factory-2022091400.zip && cd raven-factory-2022091400 -#+end_src - -** Installation Process -:PROPERTIES: -:CUSTOM_ID: installation-process -:END: -*** Enable Developer Debugging & OEM Unlock -:PROPERTIES: -:CUSTOM_ID: enable-developer-debugging-oem-unlock -:END: -Before we can actually flash anything to the phone, we will need to -enable OEM Unlocking, as well as either USB Debugging or Wireless -Debugging, depending on which method we will be using. - -To start, enable developer mode by going to =Settings= > =About= and -tapping =Build Number= seven (7) times. You may need to enter your PIN -to enable this mode. - -Once developer mode is enabled, go to =Settings= > =System= > -=Devloper Options= and enable OEM Unlocking, as well as USB or Wireless -Debugging. In my case, I chose USB Debugging and performed all actions -via USB cable. - -Once these options are enabled, plug the phone into the computer and -execute the following command: - -#+begin_src sh -adb devices -#+end_src - -If an unauthorized error occurs, make sure the USB mode on the phone is -changed from charging to something like "File Transfer" or "PTP." You -can find the USB mode in the notification tray. - -*** Reboot Device -:PROPERTIES: -:CUSTOM_ID: reboot-device -:END: -Once we have found the device via =adb=, we can either boot into the -bootloader interface by holding the volume down button while the phone -reboots or by executing the following command: - -#+begin_src sh -adb reboot bootloader -#+end_src - -*** Unlock the Bootloader -:PROPERTIES: -:CUSTOM_ID: unlock-the-bootloader -:END: -The phone will reboot and load the bootloader screen upon startup. At -this point, we are ready to start the actual flashing of GrapheneOS onto -the device. - -*NOTE*: In my situation, I needed to use =sudo= with every =fastboot= -command, but not with =adb= commands. I am not sure if this is standard -or a Fedora quirk, but I'm documenting my commands verbatim in this -post. - -First, we start by unlocking the bootloader so that we can load other -ROMs: - -#+begin_src sh -sudo fastboot flashing unlock -#+end_src - -*** Flashing Factory Images -:PROPERTIES: -:CUSTOM_ID: flashing-factory-images -:END: -Once the phone is unlocked, we can flash it with the =flash-all.sh= -script found inside the =raven-factory-2022091400= folder we entered -earlier: - -#+begin_src sh -sudo ./flash-all.sh -#+end_src - -This process should take a few minutes and will print informational -messages as things progress. Avoid doing anything on the phone while -this process is operating. - -*** Lock the Bootloader -:PROPERTIES: -:CUSTOM_ID: lock-the-bootloader -:END: -If everything was successful, the phone should reboot a few times and -finally land back on the bootloader screen. At this point, we can -re-lock the bootloader to enable full verified boot and protect the -device from unwanted flashing or erasure of data. - -#+begin_src sh -sudo fastboot flashing lock -#+end_src - -Once done, the device will be wiped and ready for a fresh set-up! diff --git a/blog/2022-10-22-alpine-linux.org b/blog/2022-10-22-alpine-linux.org deleted file mode 100644 index c5fdf1a..0000000 --- a/blog/2022-10-22-alpine-linux.org +++ /dev/null @@ -1,301 +0,0 @@ -#+title: Alpine Linux: My New Server OS -#+date: 2022-10-22 - -** Alpine Linux -:PROPERTIES: -:CUSTOM_ID: alpine-linux -:END: -[[https://alpinelinux.org][Alpine Linux]] is a very small distro, built -on musl libc and busybox. It uses ash as the default shell, OpenRC as -the init system, and apk as the package manager. According to their -website, an Alpine container "requires no more than 8 MB and a minimal -installation to disk requires around 130 MB of storage." An actual bare -metal machine is recommended to have 100 MB of RAM and 0-700 MB of -storage space. - -Historically, I've used Ubuntu's minimal installation image as my server -OS for the last five years. Ubuntu worked well and helped as my original -server contained an nVidia GPU and no onboard graphics, so quite a few -distros won't boot or install without a lot of tinkering. - -Alpine has given me a huge increase in performance across my Docker apps -and Nginx websites. CPU load for the new server I'm using to test Alpine -hovers around 0-5% on average with an Intel(R) Core(TM) i3-6100 CPU @ -3.70GHz. - -The only services I haven't moved over to Alpine are Plex Media Server -and Syncthing, which may increase CPU load quite a bit depending on how -many streams are running. - -*** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: -In terms of installation, Alpine has an incredibly useful -[[https://wiki.alpinelinux.org/wiki/Installation][wiki]] that will guide -a user throughout the installation and post-installation processes, as -well as various other articles and guides. - -To install Alpine, find an appropriate -[[https://alpinelinux.org/downloads/][image to download]] and flash it -to a USB using software such as Rufus or Etcher. I opted to use the -Standard image for my x86_64 architecture. - -Once the USB is ready, plug it into the machine and reboot. Note that -you may have to use a key such as =Esc= or =F1-12= to access the boot -menu. The Alpine Linux terminal will load quickly and for a login. - -To log in to the installation image, use the =root= account; there is no -password. Once logged-in, execute the setup command: - -#+begin_src sh -setup-alpine -#+end_src - -The setup script will ask a series of questions to configure the system. -Be sure to answer carefully or else you may have to re-configure the -system after boot. - -- Keyboard Layout (Local keyboard language and usage mode, e.g., us and - variant of us-nodeadkeys.) -- Hostname (The name for the computer.) -- Network (For example, automatic IP address discovery with the "DHCP" - protocol.) -- DNS Servers (Domain Name Servers to query. For privacy reasons, it is - NOT recommended to route every local request to servers like Google's - 8.8.8.8 .) -- Timezone -- Proxy (Proxy server to use for accessing the web. Use "none" for - direct connections to the internet.) -- Mirror (From where to download packages. Choose the organization you - trust giving your usage patterns to.) -- SSH (Secure SHell remote access server. "Openssh" is part of the - default install image. Use "none" to disable remote login, e.g. on - laptops.) -- NTP (Network Time Protocol client used for keeping the system clock in - sync with a time-server. Package "chrony" is part of the default - install image.) -- Disk Mode (Select between diskless (disk="none"), "data" or "sys", as - described above.) - -Once the setup script is finished, be sure to reboot the machine and -remove the USB device. - -#+begin_src sh -reboot -#+end_src - -*** Post-Installation -:PROPERTIES: -:CUSTOM_ID: post-installation -:END: -There are many things you can do once your Alpine Linux system is up and -running, and it largely depends on what you'll use the machine for. I'm -going to walk through my personal post-installation setup for my web -server. - -**** Upgrade the System -:PROPERTIES: -:CUSTOM_ID: upgrade-the-system -:END: -First, login as =root= in order to update and upgrade the system: - -#+begin_src sh -apk -U upgrade -#+end_src - -**** Adding a User -:PROPERTIES: -:CUSTOM_ID: adding-a-user -:END: -I needed to add a user so that I don't need to log in as root. Note that -if you're used to using the =sudo= command, you will now need to use the -=doas= command on Alpine Linux. - -#+begin_src sh -apk add doas -adduser <username> -adduser <username> wheel -#+end_src - -You can now log out and log back in using the newly-created user: - -#+begin_src sh -exit -#+end_src - -**** Enable Community Packages -:PROPERTIES: -:CUSTOM_ID: enable-community-packages -:END: -In order to install more common packages that aren't found in the =main= -repository, you will need to enable the =community= repository: - -#+begin_src sh -doas nano /etc/apk/repositories -#+end_src - -Uncomment the community line for whichever version of Alpine you're -running: - -#+begin_src sh -/media/usb/apks -http://dl-cdn.alpinelinux.org/alpine/v3.16/main -http://dl-cdn.alpinelinux.org/alpine/v3.16/community -#http://dl-cdn.alpinelinux.org/alpine/edge/main -#http://dl-cdn.alpinelinux.org/alpine/edge/community -#http://dl-cdn.alpinelinux.org/alpine/edge/testing -#+end_src - -**** Install Required Packages -:PROPERTIES: -:CUSTOM_ID: install-required-packages -:END: -Now that the community packages are available, you can install any -packages you need. In my case, I installed the web server packages I -need for my services: - -#+begin_src sh -doas apk add nano nginx docker docker-compose ufw -#+end_src - -**** SSH -:PROPERTIES: -:CUSTOM_ID: ssh -:END: -If you didn't install OpenSSH as part of the installation, you can do so -now: - -#+begin_src sh -doas apk add openssh -#+end_src - -Next, either create a new key or copy your SSH key to the server from -your current machines: - -#+begin_src sh -# Create a new key -ssh-keygen -#+end_src - -If you need to copy an existing SSH key from a current machine: - -#+begin_src sh -# Copy key from existing machines -ssh-copy-id <username>@<ip_address> -#+end_src - -**** Firewall -:PROPERTIES: -:CUSTOM_ID: firewall -:END: -Lastly, I installed =ufw= above as my firewall. To set up, default to -deny incoming and allow outgoing connections. Then selectively allow -other ports or apps as needed. - -#+begin_src sh -doas ufw default deny incoming -doas ufw default allow outgoing -doas ufw allow SSH -doas ufw allow "WWW Full" -doas ufw allow 9418 # Git server port -#+end_src - -**** Change Hostname -:PROPERTIES: -:CUSTOM_ID: change-hostname -:END: -If you don't like the hostname set during installation, you just need to -edit two files. First, edit the simple hostname file: - -#+begin_src sh -doas nano /etc/hostname -#+end_src - -#+begin_src sh -<hostname> -#+end_src - -Next, edit the =hosts= file: - -#+begin_src sh -doas nano /etc/hosts -#+end_src - -#+begin_src sh -127.0.0.1 <hostname>.local <hostname> localhost.local localhost -::1 <hostname> <hostname>.local -#+end_src - -** Nginx Web Server -:PROPERTIES: -:CUSTOM_ID: nginx-web-server -:END: -To set up my web server, I simply created the =www= user and created the -necessary files. - -#+begin_src sh -doas adduser -D -g 'www' www -mkdir /www -doas mkdir /www -doas chown -R www:www /var/lib/nginx/ -doas chown -R www:www /www -#+end_src - -If you're running a simple webroot, you can alter the main =nginx.conf= -file. Otherwise, you can drop configuration files in the following -directory. You don't need to enable or symlink the configuration file -like you do in other systems. - -#+begin_src sh -doas nano /etc/nginx/http.d/example_website.conf -#+end_src - -Once the configuration is set and pointed at the =/www= directory to -serve files, enable the Nginx service: - -#+begin_src sh -# Note that 'default' must be included or Nginx will not start on boot -doas rc-update add nginx default -#+end_src - -** Docker Containers -:PROPERTIES: -:CUSTOM_ID: docker-containers -:END: -Docker works exactly the same as other systems. Either execute a -=docker run= command or create a =docker-compose.yml= file and do -=docker-compose up -d=. - -** Git Server -:PROPERTIES: -:CUSTOM_ID: git-server -:END: -I went in-depth on how to self-host a git server in another post: -[[/blog/git-server/][Self-Hosting a Personal Git Server]]. - -However, there are a few differences with Alpine. First note that in -order to change the =git= user's shell, you must do a few things a -little different: - -#+begin_src sh -doas apk add libuser -doas touch /etc/login.defs -doas mkdir /etc/default -doas touch /etc/default/useradd -doas lchsh git -#+end_src - -** Thoughts on Alpine -:PROPERTIES: -:CUSTOM_ID: thoughts-on-alpine -:END: -So far, I love Alpine Linux. I have no complaints about anything at this -point, but I'm not completely finished with the migration yet. Once I'm -able to upgrade my hardware to a rack-mounted server, I will migrate -Plex and Syncthing over to Alpine as well - possibly putting Plex into a -container or VM. - -The performance is stellar, the =apk= package manager is seamless, and -system administration tasks are effortless. My only regret is that I -didn't install Alpine sooner. diff --git a/blog/2022-10-30-linux-display-manager.org b/blog/2022-10-30-linux-display-manager.org deleted file mode 100644 index 3fe59cb..0000000 --- a/blog/2022-10-30-linux-display-manager.org +++ /dev/null @@ -1,85 +0,0 @@ -#+title: How to Disable or Change the Display Manager on Void Linux -#+date: 2022-10-30 - -** Display Manager Services -:PROPERTIES: -:CUSTOM_ID: display-manager-services -:END: -In order to change the -[[https://en.wikipedia.org/wiki/Display_manager][display manager]] on -Void Linux - or any other Linux distro - you need to identify the -currently enabled display manager. - -*** Disabling the Current Display Manager -:PROPERTIES: -:CUSTOM_ID: disabling-the-current-display-manager -:END: -Void Linux only has one ISO available for download with a pre-built -display manager at the time of this post: the XFCE ISO. If you've -installed this version, the pre-assigned display manager is =lxdm=. If -you installed another display manager, replace =lxdm= in the following -command with the display manager you have installed. - -To disable =lxdm=, simply remove the service symlink: - -#+begin_src sh -sudo rm /var/service/lxdm -#+end_src - -*** Enabling a New Display Manager -:PROPERTIES: -:CUSTOM_ID: enabling-a-new-display-manager -:END: -If you want to enable a new display manager, you can do so after =lxdm= -is disabled. Make sure to replace =<new_display_manager>= with your new -DM, such as =gdm=, =xdm=, etc. - -#+begin_src sh -sudo ln -s /etc/sv/<new_display_manager> /var/service -#+end_src - -** Set Up =.xinitrc= -:PROPERTIES: -:CUSTOM_ID: set-up-.xinitrc -:END: -Depending on your setup, you may need to create a few X files, such as -=~/.xinitrc=. For my personal set-up, I created this file to launch the -i3wm as my desktop. - -#+begin_src sh -nano ~/.xinitrc -#+end_src - -#+begin_src sh -#!/bin/sh - -exec i3 -#+end_src - -If you run a desktop other than i3, simply replace =i3= with the shell -command that launches that desktop. - -** Set Up Your Shell Profile -:PROPERTIES: -:CUSTOM_ID: set-up-your-shell-profile -:END: -Finally, in order to automatically launch an X session upon login, you -will need to edit the =.bash_profile= (bash) or =.zprofile= (zsh) files -for your shell: - -#+begin_src sh -nano ~/.zprofile -#+end_src - -Add the following snippet to the end of the shell profile file. This -will execute the =startx= command upon login. - -#+begin_src sh -if [ -z "${DISPLAY}" ] && [ "${XDG_VTNR}" -eq 1 ]; then - exec startx -fi -#+end_src - -Alternatively, you can ignore this step and simply choose to manually -execute =startx= upon login. This can be useful if you have issues with -your desktop or like to manually launch different desktops by choice. diff --git a/blog/2022-12-01-nginx-compression.org b/blog/2022-12-01-nginx-compression.org deleted file mode 100644 index c3669dd..0000000 --- a/blog/2022-12-01-nginx-compression.org +++ /dev/null @@ -1,83 +0,0 @@ -#+title: Enable GZIP Compression on Nginx -#+date: 2022-12-01 - -** Text Compression -:PROPERTIES: -:CUSTOM_ID: text-compression -:ID: 24C2F6E7-129E-42F3-91F0-A6C6C519FA01 -:END: -Text compression allows a web server to serve text-based resources -faster than uncompressed data. This can speed up things like First -Contentful Paint, Tie to Interactive, and Speed Index. - -** Enable Nginx Compression with gzip -:PROPERTIES: -:CUSTOM_ID: enable-nginx-compression-with-gzip -:ID: C018C991-E253-4779-A702-AEB69614499F -:END: -In order to enable text compression on Nginx, we need to enable it -within the configuration file: - -#+begin_src sh -nano /etc/nginx/nginx.conf -#+end_src - -Within the =http= block, find the section that shows something like the -block below. This is the default gzip configuration I found in my -=nginx.conf= file on Alpine Linux 3.17. Yours may look slightly -different, just make sure that you're not creating any duplicate gzip -options. - -#+begin_src conf -# Enable gzipping of responses. -#gzip on; - -# Set the Vary HTTP header as defined in the RFC 2616. Default is 'off'. -gzip_vary on; -#+end_src - -Remove the default gzip lines and replace them with the following: - -#+begin_src conf -# Enable gzipping of responses. -gzip on; -gzip_vary on; -gzip_min_length 10240; -gzip_proxied expired no-cache no-store private auth; -gzip_types text/plain text/css text/xml text/javascript application/x-javascript application/xml; -gzip_disable "MSIE [1-6]\."; -#+end_src - -** Explanations of ngx_http_gzip_module Options -:PROPERTIES: -:CUSTOM_ID: explanations-of-ngx_http_gzip_module-options -:ID: C180752B-E1B9-49A5-B180-84488068A76A -:END: -Each of the lines above enables a different aspect of the gzip response -for Nginx. Here are the full explanations: - -- =gzip= -- Enables or disables gzipping of responses. -- =gzip_vary= -- Enables or disables inserting the "Vary: - Accept-Encoding" response header field if the directives gzip, - gzip_static, or gunzip are active. -- =gzip_min_length= -- Sets the minimum length of a response that will - be gzipped. The length is determined only from the "Content-Length" - response header field. -- =gzip_proxied= -- Enables or disables gzipping of responses for - proxied requests depending on the request and response. The fact that - the request is proxied is determined by the presence of the "Via" - request header field. -- =gzip_types= -- Enables gzipping of responses for the specified MIME - types in addition to "text/html". The special value “*” matches any - MIME type (0.8.29). Responses with the "text/html" type are always - compressed. -- =gzip_disable= -- Disables gzipping of responses for requests with - "User-Agent" header fields matching any of the specified regular - expressions. - - The special mask "msie6" (0.7.12) corresponds to the regular - expression "MSIE [4-6].", but works faster. Starting from version - 0.8.11, "MSIE 6.0; ... SV1" is excluded from this mask. - -More information on these directives and their options can be found on -the [[https://nginx.org/en/docs/http/ngx_http_gzip_module.html][Module -ngx_http_gzip_module]] page in Nginx's documentation. diff --git a/blog/2022-12-17-st.org b/blog/2022-12-17-st.org deleted file mode 100644 index d47993b..0000000 --- a/blog/2022-12-17-st.org +++ /dev/null @@ -1,100 +0,0 @@ -#+title: Simple Terminal -#+date: 2022-12-17 - -** st -:PROPERTIES: -:CUSTOM_ID: st -:END: -[[https://st.suckless.org][st]] standards for Simple Terminal, a simple -terminal implementation for X made by the -[[https://suckless.org][suckless]] team. - -This post walks through the dependencies needed and process to build and -install =st= on Fedora Workstation. - -*** Obtain Files -:PROPERTIES: -:CUSTOM_ID: obtain-files -:END: -To start, obtain the source files for =st= via =git clone=. - -#+begin_src sh -mkdir ~/suckless && cd ~/suckless -git clone https://git.suckless.org/st && cd st -#+end_src - -*** Dependencies -:PROPERTIES: -:CUSTOM_ID: dependencies -:END: -Once you have the files and are in the =st= directory, ensure the -following packages are installed. - -#+begin_src sh -sudo dnf update && sudo dnf upgrade -sudo dnf install gcc patch libX11-devel libXft-devel -#+end_src - -*** Building -:PROPERTIES: -:CUSTOM_ID: building -:END: -Before building, ensure that you read the README file. - -#+begin_src sh -cat README -#+end_src - -Once you've read the instructions, open the =config.mk= file and ensure -it matches your setup. If you're not sure, leave the default options -within the file. - -Finally, you can build =st= with the following command. Ensure you run -as root (e.g., =sudo=) or else you may not end up with a usable -application file. - -#+begin_src sh -sudo make clean install -#+end_src - -*** Customization (Patches) -:PROPERTIES: -:CUSTOM_ID: customization-patches -:END: -Note that customizing =st= requires you to modify the source files or to -download one of the [[https://st.suckless.org/patches/][available -patches]] for suckless.org. - -If you've already installed =st= and want to customize or install a -patch, start by uninstalling the current program. - -#+begin_src sh -cd ~/suckless/st -sudo make uninstall -#+end_src - -Next, grab the =<path>.diff= file from the page of the patch you chose. -For example, I will be using the -[[https://st.suckless.org/patches/defaultfontsize/][defaultfontsize]] -patch in the below example. - -#+begin_src sh -wget https://st.suckless.org/patches/defaultfontsize/st-defaultfontsize-20210225-4ef0cbd.diff -#+end_src - -Once the file is downloaded inside the =st= folder, apply the patch and -re-install the program. You may need to install the =patch= command if -you don't have it installed already (you should have installed it -above). - -#+begin_src sh -patch -i st-defaultfontsize-20210225-4ef0cbd.diff -sudo make clean install -#+end_src - -Once installed, you can use the default font size patch to launch =st= -with any font size you wish: - -#+begin_src sh -st -z 16 -#+end_src diff --git a/blog/2023-02-02-exploring-hare.org b/blog/2023-02-02-exploring-hare.org deleted file mode 100644 index c934b7d..0000000 --- a/blog/2023-02-02-exploring-hare.org +++ /dev/null @@ -1,189 +0,0 @@ -#+title: Exploring the Hare Programming Language -#+date: 2023-02-02 - -** A Quick Note -:PROPERTIES: -:CUSTOM_ID: a-quick-note -:END: -By no means am I a professional developer, so this post will be rather -short. I won't be going into depth on the specification or anything that -technical. - -Instead, I will simply be talking about how I (a relatively basic -hobbyist programmer) have been playing with Hare and what intrigues me -about the language. - -** Hare -:PROPERTIES: -:CUSTOM_ID: hare -:END: -The [[https://harelang.org][Hare]] programming language is a -straightforward language that should look familiar if you've ever -programmed with C, Rust, or other languages that aim to build software -at the system-level. - -The Hare homepage states the following: - -#+begin_quote -Hare is a systems programming language designed to be simple, stable, -and robust. Hare uses a static type system, manual memory management, -and minimal runtime. It is well-suited to writing operating systems, -system tools, compilers, networking software, and other low-level, high -performance tasks. - -#+end_quote - -I have found this all to be true while playing with it for the first -time today. In the next few sections, I'm going to walk through my -installation and first program. - -*** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: -I'm currently running Alpine Linux on my Thinkpad, so the installation -was quite easy as there is a package for Hare in the =apk= repositories. - -#+begin_src sh -doas apk add hare hare-doc -#+end_src - -However, I was able to install Hare from scratch on Fedora Linux a short -while ago, which was also very easy to do. If you need further -instructions and Hare doesn't have a package on your system, take a look -at the [[https://harelang.org/installation/][Hare Installation]] page. - -*** Creating a Test Project -:PROPERTIES: -:CUSTOM_ID: creating-a-test-project -:END: -In order to play with the language, I created -[[https://git.sr.ht/~cmc/hare-projects][hare-test]] and will be putting -any of my Hare-related adventures in here. - -#+begin_quote -*Update:* I also created a simple Hare program for creating a file from -user input: -[[https://git.sr.ht/~cmc/hare-projects/tree/main/item/files/files.ha][files.ha]] - -#+end_quote - -Luckily, Hare doesn't require any complex set-up tools or build -environment. Once you have Hare installed, you simply need to create a -file ending with =.ha= and you can run a Hare program. - -I created a file called =rgb.ha= in order to test out the random number -generation and passing parameters between functions. - -#+begin_src sh -nano rgb.ha -#+end_src - -Within this file, I was able to easily import a few of the -[[https://harelang.org/tutorials/stdlib/][standard library modules]]: -=fmt=, =math::random=, and =datetime=. - -With these modules, I created two functions: - -1. =main=: This function calls the =generate_rgb= function and then - prints out the returned values. -2. =generate_rgb=: This function uses the current Unix epoch time to - generate a pseudo-random value and uses this value to create three - more random values between 0 and 255. These three numbers represent a - color in RGB format. - -#+begin_quote -*Note*: Some syntax coloring may look odd, as Zola currently doesn't -have a syntax highlighting theme for Hare. Instead, I'm using the C -theme, which may not be exactly accurate when coloring the code below. - -#+end_quote - -#+begin_src C -use datetime; -use fmt; -use math::random; - -export fn main() void = { - const rgb = generate_rgb(); - fmt::printfln("RGB: ({}, {}, {})", rgb[0], rgb[1], rgb[2])!; -}; - -fn generate_rgb() []u64 = { - // Use the current Unix epoch time as the seed value - let datetime = datetime::epochunix(&datetime::now()); - - // Generate initial pseudo-random value - // You must cast the datetime from int to u64 - let x = random::init(datetime: u64); - - // Generate RGB values between (0, 255) using pseudo-random init value - let r = random::u64n(&x, 255); - let g = random::u64n(&x, 255); - let b = random::u64n(&x, 255); - - // Structure data as array and return - let rgb_array: [3]u64 = [r, g, b]; - return rgb_array; -}; -#+end_src - -*** Running a Program -:PROPERTIES: -:CUSTOM_ID: running-a-program -:END: -Once you have a Hare file written and ready to run, you simply need to -run it: - -#+begin_src sh -hare run file.ha -#+end_src - -You can also compile the program into an executable: - -#+begin_src sh -hare build -o example file.ha -./example -#+end_src - -*** Initial Thoughts -:PROPERTIES: -:CUSTOM_ID: initial-thoughts -:END: -**** Documentation Improvements Would Help -:PROPERTIES: -:CUSTOM_ID: documentation-improvements-would-help -:END: -While I was able to piece everything together eventually, the biggest -downfall right now in Hare's documentation. For such a new project, the -documentation is in a great spot. However, bare specifications don't -help as much as a brief examples section would. - -For example, it took me a while to figure out what the =u64n= function -was looking for. I could tell that it took two parameters and the second -was my max value (255), but couldn't figure out what the first value -should be. Eventually, I inspected the =random.ha= file in the -[[https://git.sr.ht/~sircmpwn/hare/tree/master/item/math/random/random.ha][Hare -source code]] and found the test suite that helped me discover that it -needed an =init()= value in the form of =&var=. - -**** More Basic Modules -:PROPERTIES: -:CUSTOM_ID: more-basic-modules -:END: -This is another point that comes from Hare being new and awaiting more -contributions, but there are some basic functions that I would -personally enjoy seeing in Hare, such as one to convert decimal -(base 10) values to hexadecimal (base 16). - -If I'm feeling comfortable with my math, I may work on the list of -functions I want and see if any can make it into the Hare source code. - -**** Overall Thoughts -:PROPERTIES: -:CUSTOM_ID: overall-thoughts -:END: -Overall, I actually really enjoy Hare. It's not as tedious to get a -project up and running as Rust, but it's also simpler and more -user-friendly than learning C. I am going to continue playing with it -and see if I can make anything of particular value. diff --git a/blog/2023-06-18-unifi-ip-blocklist.org b/blog/2023-06-18-unifi-ip-blocklist.org deleted file mode 100644 index 21dfd1d..0000000 --- a/blog/2023-06-18-unifi-ip-blocklist.org +++ /dev/null @@ -1,89 +0,0 @@ -#+title: Block IP Addresses and Subnets with the Unifi Network Firewall -#+date: 2023-06-18 - -** Identifying Abusive IPs -:PROPERTIES: -:CUSTOM_ID: identifying-abusive-ips -:END: -If you're like me and use Unifi network equipment at the edge of the -network you manage, you may know that Unifi is only somewhat decent at -identifying and blocking IPs that represent abusive or threat actors. - -While Unifi has a -[[https://help.ui.com/hc/en-us/articles/360006893234-UniFi-Gateway-Threat-Management][threat -management]] tool inside their Network application, it can be lacking in -functionality and identification. For example, I have my UDM Pro set to -identify and block almost all categories of threats available within the -Unifi settings. However, I regularly identify abusive actors on my web -server via the server logs. - -In addition, I have identified IP addresses and subnets directly within -Unifi's logs that the UDM did not block for whatever reason. - -This guide is meant to be another step in the process to manually block -abusive IP addresses or subnets that you have identified but are not -being automatically blocked yet. - -** Create an IP Group Profile -:PROPERTIES: -:CUSTOM_ID: create-an-ip-group-profile -:END: -To start, login to the Unifi machine's web GUI and navigate to the -Network app > Settings > Profiles. - -Within this page, choose the =IP Groups= tab and click =Create New=. - -#+caption: Network Profiles -[[https://img.cleberg.net/blog/20230618-unifi-ip-blocklist/unifi_profiles.png]] - -Each IP Group profile can be used as one of three options: - -1. Port Group -2. IPv4 Address/Subnet -3. IPv6 Address/Subnet - -In this example, I'm creating an IPv4 Address/Subnet group and adding a -few different IP addresses and a subnet. Once you've added all IP -addresses and subnets, click the =Apply= button that should appear at -the bottom. - -#+caption: Network Profile IPs -[[https://img.cleberg.net/blog/20230618-unifi-ip-blocklist/abusive_ips.png]] - -At this point, the IPv4 Address/Subnet has been created but not yet -used. - -** Drop IP Group Profile via the Unifi Firewall -:PROPERTIES: -:CUSTOM_ID: drop-ip-group-profile-via-the-unifi-firewall -:END: -To instruct the Unifi machine to block the profile we just created, we -need to navigate to the Network app > Settings > Firewall & Security. - -Within this screen, find the Firewall Rules table and click -=Create Entry=. This entry should contain the following settings: - -- Type: =Internet In= -- Description: =<Your Custom Rule>= -- Rule Applied: =Before Predefined Rules= -- Action: =Drop= -- Source Type: =Port/IP Group= -- IPv4 Address Group: =<Name of the Group Profile You Created Above>= - -Customize the remaining configurations to your liking, and then save and -enable the firewall rule. - -#+caption: Firewall Rule -[[https://img.cleberg.net/blog/20230618-unifi-ip-blocklist/firewall_drop_rule.png]] - -Once enabled, the Unifi machine will be able to drop all incoming -connections from the defined IP addresses and subnets within the created -profile. - -#+begin_quote -As a personal aside to this topic, I'm looking for a convenient way to -update the firewall rules or profiles remotely (within the LAN) from the -web server to accelerate this process. If you have an idea on how to -automatically update Unifi IP groups or firewall rules, let me know! - -#+end_quote diff --git a/blog/2023-06-20-audit-review-cheatsheet.org b/blog/2023-06-20-audit-review-cheatsheet.org deleted file mode 100644 index 6d964fa..0000000 --- a/blog/2023-06-20-audit-review-cheatsheet.org +++ /dev/null @@ -1,81 +0,0 @@ -#+title: Audit Review Checklist -#+date: 2023-06-20 - - -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: -This post is a /very/ brief overview on the basic process to review -audit test results, focusing on work done as part of a financial -statement audit (FSA) or service organization controls (SOC) report. - -While there are numerous different things to review and look for - all -varying wildly depending on the report, client, and tester - this list -serves as a solid base foundation for a reviewer. - -I have used this throughout my career as a starting point to my reviews, -and it has worked wonders for creating a consistent and objective -template to my reviews. The goal is to keep this base high-level enough -to be used on a wide variety of engagements, while still ensuring that -all key areas are covered. - -** Cheatsheet -:PROPERTIES: -:CUSTOM_ID: cheatsheet -:END: -1. [ ] Check all documents for spelling and grammar. -2. [ ] Ensure all acronyms are fully explained upon first use. -3. [ ] For all people referenced, use their full names and job titles - upon first use. -4. [ ] All supporting documents must cross-reference to the lead sheet - and vice-versa. -5. [ ] Verify that the control has been adequately tested: - - [ ] *Test of Design*: Did the tester obtain information regarding - how the control should perform normally and abnormally (e.g., - emergency scenarios)? - - [ ] *Test of Operating Effectiveness*: Did the tester inquire, - observe, inspect, or re-perform sufficient evidence to support - their conclusion over the control? Inquiry alone is not adequate! -6. [ ] For any information used in the control, whether by the control - operator or by the tester, did the tester appropriately document the - source (system or person), extraction method, parameters, and - completeness and accuracy (C&A)? - - [ ] For any reports, queries, etc. used in the extraction, did the - tester include a copy and notate C&A considerations? -7. [ ] Did the tester document the specific criteria that the control is - being tested against? -8. [ ] Did the tester notate in the supporting documents where each - criterion was satisfied? -9. [ ] If testing specific policies or procedures, are the documents - adequate? - - [ ] e.g., a test to validate that a review of policy XYZ occurs - periodically should also evaluate the sufficiency of the policy - itself, if meant to cover the risk that such a policy does not - exist and is not reviewed. -10. [ ] Does the test cover the appropriate period under review? - - [ ] If the test is meant to cover only a portion of the audit - period, do other controls exist to mitigate the risks that exist - for the remainder of the period? -11. [ ] For any computer-aided audit tools (CAATs) or other automation - techniques used in the test, is the use of such tools explained and - appropriately documented? -12. [ ] If prior-period documentation exists, are there any missing - pieces of evidence that would further enhance the quality of the - test? -13. [ ] Was any information discovered during the walkthrough or inquiry - phase that was not incorporated into the test? -14. [ ] Are there new rules or expectations from your company's internal - guidance or your regulatory bodies that would affect the audit - approach for this control? -15. [ ] Was an exception, finding, or deficiency identified as a result - of this test? - - [ ] Was the control deficient in design, operation, or both? - - [ ] What was the root cause of the finding? - - [ ] Does the finding indicate other findings or potential fraud? - - [ ] What's the severity and scope of the finding? - - [ ] Do other controls exist as a form of compensation against the - finding's severity, and do they mitigate the risk within the - control objective? - - [ ] Does the finding exist at the end of the period, or was it - resolved within the audit period? diff --git a/blog/2023-06-28-backblaze-b2.org b/blog/2023-06-28-backblaze-b2.org deleted file mode 100644 index df14501..0000000 --- a/blog/2023-06-28-backblaze-b2.org +++ /dev/null @@ -1,207 +0,0 @@ -#+title: Getting Started with Backblaze B2 Cloud Storage -#+date: 2023-06-28 - -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: -Backblaze [[https://www.backblaze.com/b2/cloud-storage.html][B2 Cloud -Storage]] is an inexpensive and reliable on-demand cloud storage and -backup solution. - -The service starts at $5/TB/month ($0.005/GB/month) with a download rate -of $0.01/GB/month. - -However, there are free tiers: - -- The first 10 GB of storage is free. -- The first 1 GB of data downloaded each day is free. -- Class A transactions are free. -- The first 2500 Class B transactions each day are free. -- The first 2500 Class C transactions each day are free. - -You can see which API calls fall into categories A, B, or C here: -[[https://www.backblaze.com/b2/b2-transactions-price.html][Pricing -Organized by API Calls]]. - -For someone like me, who wants an offsite backup of their server's -=/home/= directory and various other server configs that fall under 10 -GB total, Backblaze is a great solution from a financial perspective. - -** Create An Account -:PROPERTIES: -:CUSTOM_ID: create-an-account -:END: -To start with Backblaze, you'll need to -[[https://www.backblaze.com/b2/sign-up.html][create a free account]] - -no payment method is required to sign up. - -Once you have an account, you can test out the service with their web -GUI, their mobile app, or their CLI tool. I'm going to use the CLI tool -below to test a file upload and then sync an entire directory to my -Backblaze bucket. - -** Create a Bucket -:PROPERTIES: -:CUSTOM_ID: create-a-bucket -:END: -Before you can start uploading, you need to create a bucket. If you're -familiar with other object storage services, this will feel familiar. If -not, it's pretty simple to create one. - -As their webpage says: - -#+begin_quote -A bucket is a container that holds files that are uploaded into B2 Cloud -Storage. The bucket name must be globally unique and must have a minimum -of 6 characters. A limit of 100 buckets may be created per account. An -unlimited number of files may be uploaded into a bucket. - -#+end_quote - -Once you click the =Create a Bucket= button on their webpage or mobile -app, you need to provide the following: - -- Bucket Unique Name -- Files in Bucket are: =Private= or =Public= -- Default Encryption: =Disable= or =Enable= -- Object Lock: =Disable= or =Enable= - -For my bucket, I created a private bucket with encryption enabled and -object lock disabled. - -Once your bucket is created, you can test the upload/download feature on -their web GUI or mobile app! At this point, you have a fully functional -bucket and account. - -** Linux CLI Tool -:PROPERTIES: -:CUSTOM_ID: linux-cli-tool -:END: -*** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: -To install the =b2= CLI tool, you'll need to download it from the -[[https://www.backblaze.com/docs/cloud-storage-command-line-tools][CLI -Tools]] page. I recommend copying the URL from the link that says -=Linux= and using wget to download it, as shown below. - -Once downloaded, make the file executable and move it to a location on -your =$PATH=, so that you can execute that command from anywhere on the -machine. - -#+begin_src sh -wget <b2_cli_url> -chmod +x b2_linux -mv b2_linux /usr/bin/b2 -#+end_src - -*** Log In -:PROPERTIES: -:CUSTOM_ID: log-in -:END: -The first step after installation is to log in. To do this, execute the -following command and provide your =<applicationKeyId>= and -=<applicationKey>=. - -If you don't want to provide these values in the command itself, you can -simply execute the base command and it will request them in an -interactive prompt. - -#+begin_src sh -# if you want to provide the keys directly: -b2 authorize-account [<applicationKeyId>] [<applicationKey>] - -# or, if you don't want your keys in your shell history: -b2 authorize-account -#+end_src - -*** Upload a Test File -:PROPERTIES: -:CUSTOM_ID: upload-a-test-file -:END: -In order to test the functionality of the CLI tool, I'll start by -uploading a single test file to the bucket I created above. We can do -this with the =upload_file= function. - -The command is issued as follows: - -#+begin_src sh -b2 upload_file <bucket_name> <local_file> <remote_file> -#+end_src - -In my situation, I executed the following command with my username. - -#+begin_src sh -b2 upload_file my_unique_bucket /home/<user>/test.md test.md -#+end_src - -To confirm that the file was uploaded successfully, list the files in -your bucket: - -#+begin_src sh -b2 ls <bucket_name> -#+end_src - -#+begin_src txt -test.md -#+end_src - -*** Sync a Directory -:PROPERTIES: -:CUSTOM_ID: sync-a-directory -:END: -If you have numerous files, you can use the =sync= function to perform -functionality similar to =rsync=, where you can check what's in your -bucket and sync anything that is new or modified. - -The command is issued as follows: - -#+begin_src sh -b2 sync <source file location> <B2 bucket destination> -#+end_src - -In my case, I can sync my user's entire home directory to my bucket -without specifying any of the files directly: - -#+begin_src sh -b2 sync /home/<user>/ "b2://<bucketName>/home/<user>" -#+end_src - -** Caveats -:PROPERTIES: -:CUSTOM_ID: caveats -:END: -*** Timing of Updates to the Web GUI -:PROPERTIES: -:CUSTOM_ID: timing-of-updates-to-the-web-gui -:END: -When performing actions over a bucket, there is a slight delay in the -web GUI when inspecting a bucket or its file. Note that simple actions -such as uploading or deleting files may have a delay of a few minutes up -to 24 hours. In my experience (<10 GB and ~20,000 files), any actions -took only a few minutes to update across clients. - -*** Symlinks -:PROPERTIES: -:CUSTOM_ID: symlinks -:END: -Note that symlinks are resolved by b2, so if you have a link from -=/home/<user>/nas-storage= that symlinks out to a =/mnt/nas-storage= -folder that has 10TB of data, =b2= will resolve that link and start -uploading all 10TB of data linked within the folder. - -If you're not sure if you have any symlinks, a symlink will look like -this (note the =->= symbol): - -#+begin_src sh -> ls -lha -lrwxrwxrwx 1 root root 20 Jun 28 13:32 nas -> /mnt/nas-storage/ -#+end_src - -You can recursively find symlink in a path with the following command: - -#+begin_src sh -ls -lR /path/to/search | grep '^l' -#+end_src diff --git a/blog/2023-08-18-agile-auditing.org b/blog/2023-08-18-agile-auditing.org deleted file mode 100644 index 530c4e7..0000000 --- a/blog/2023-08-18-agile-auditing.org +++ /dev/null @@ -1,172 +0,0 @@ -#+title: Agile Auditing: An Introduction -#+date: 2023-08-18 - -** What is Agile Auditing? -:PROPERTIES: -:CUSTOM_ID: what-is-agile-auditing -:END: -[[https://en.wikipedia.org/wiki/Agile_software_development][Agile]], the -collaborative philosophy behind many software development methods, has -been picking up steam as a beneficial tool to use in the external and -internal auditing world. - -This blog post will walk through commonly used terms within Agile, -Scrum, and Kanban in order to translate these terms and roles into -audit-specific terms. - -Whether your team is in charge of a financial statement audit, an -attestation (SOC 1, SOC 2, etc.), or a unique internal audit, the terms -used throughout this post should still apply. - -** Agile -:PROPERTIES: -:CUSTOM_ID: agile -:END: -To start, I'll take a look at Agile. - -#+begin_quote -The Agile methodology is a project management approach that involves -breaking the project into phases and emphasizes continuous collaboration -and improvement. Teams follow a cycle of planning, executing, and -evaluating. - -#+end_quote - -While this approach may seem familiar to what audit teams have -historically done, an audit team must make distinct changes in their -mentality and how they approach and manage a project. - -*** Agile Values -:PROPERTIES: -:CUSTOM_ID: agile-values -:END: -The Agile Manifesto, written in 2001 at a summit in Utah, contain a set -of four main values that comprise the Agile approach: - -1. Individuals and interactions over processes and tools. -2. Working software over comprehensive documentation. -3. Customer collaboration over contract negotiation. -4. Responding to change over following a plan. - -Beyond the four values, -[[https://agilemanifesto.org/principles.html][twelve principles]] were -also written as part of the summit. - -In order to relate these values to an audit or attestation engagement, -we need to shift the focus from software development to the main goal of -an engagement: completing sufficient audit testing to address to -relevant risks over the processes and controls at hand. - -Audit Examples: - -- Engagement teams must value the team members, client contacts, and - their interactions over the historical processes and tools that have - been used. -- Engagement teams must value a final report that contains sufficient - audit documentation over excessive documentation or scope creep. -- Engagement teams must collaborate with the audit clients as much as - feasible to ensure that both sides are constantly updated with current - knowledge of the engagement's status and any potential findings, - rather than waiting for pre-set meetings or the end of the engagement - to communicate. -- Engagement teams must be able to respond to change in an engagement's - schedule, scope, or environment to ensure that the project is - completed in a timely manner and that all relevant areas are tested. - - In terms of an audit department's portfolio, they must be able to - respond to changes in their company's or client's environment and be - able to dynamically change their audit plan accordingly. - -** Scrum -:PROPERTIES: -:CUSTOM_ID: scrum -:END: -The above section discusses the high-level details of the Agile -philosophy and how an audit team can potentially mold that mindset into -the audit world, but how does a team implement these ideas? - -There are many methods that use an Agile mindset, but I prefer -[[https://en.wikipedia.org/wiki/Scrum_(software_development)][Scrum]]. -Scrum is a framework based on Agile that enables a team to work through -a project through a series of roles, ceremonies, artifacts, and values. - -Let's dive into each of these individually. - -*** Scrum Team -:PROPERTIES: -:CUSTOM_ID: scrum-team -:END: -A scrum project is only as good as the team running the project. -Standard scrum teams are separated into three distinct areas: - -1. *Product Owner (Client Contact)*: The client contact is the audit - equivalent of the product owner in Scrum. They are responsible for - partnering with the engagement or audit team to ensure progress is - being made, priorities are established, and clear guidance is given - when questions or findings arise within each sprint. -2. *Scrum Master (Engagement Lead)*: The engagement or audit team lead - is responsible for coaching the team and the client contact on the - scrum process, tracking team progress against plan, scheduling - necessary resources, and helping remove obstacles. -3. *Scrum Developers (Engagement Members)*: The engagement or audit team - is the set of team members responsible for getting the work done. - These team members will work on each task, report progress, resolve - obstacles, and collaborate with other team members and the client - contact to ensure goals are being met. - -*** Scrum Ceremonies -:PROPERTIES: -:CUSTOM_ID: scrum-ceremonies -:END: -Scrum ceremonies are events that are performed on a regular basis. - -1. *Sprint Planning*: The team works together to plan the upcoming - sprint goal and which user stories (tasks) will be added to the - sprint to achieve that goal. -2. *Sprint*: The time period, typically at least one week and no more - than one month in length, where the team works on the stories and - anything in the backlog. -3. *Daily Scrum*: A very short meeting held each day, typically 15 - minutes, to quickly emphasize alignment on the sprint goal and plan - the next 24 hours. Each team member may share what they did the day - before, what they'll do today, and any obstacles to their work. -4. *Sprint Review*: At the end of each sprint, the team will gather and - discuss the progress, obstacles, and backlog from the previous - sprint. -5. *Sprint Retrospective*: More specific than the sprint review, the - retrospective is meant to discuss what worked and what did not work - during the sprint. This may be processes, tools, people, or even - things related to the Scrum ceremonies. - -One additional ceremony that may be applicable is organizing the -backlog. This is typically the responsibility of the engagement leader -and is meant to prioritize and clarify what needs to be done to complete -items in the backlog. - -*** Artifacts -:PROPERTIES: -:CUSTOM_ID: artifacts -:END: -While artifacts are generally not customizable in the audit world (i.e., -each control test must include some kind of working paper with evidence -supporting the test results), I wanted to include some quick notes on -associating scrum artifact terms with an audit. - -1. *Product Backlog*: This is the overall backlog of unfinished audit - tasks from all prior sprints. -2. *Sprint Backlog*: This is the backlog of unfinished audit tasks from - one individual sprint. -3. *Increment*: This is the output of each sprint - generally this is - best thought of as any documentation prepared during the sprint, such - as risk assessments, control working papers, deficiency analysis, - etc. - -** Kanban -:PROPERTIES: -:CUSTOM_ID: kanban -:END: -Last but not least, Kanban is a methodology that relies on boards to -categorize work into distinct, descriptive categories that allow an -agile or scrum team to effectively plan the work of a sprint or project. - -See Atlassian's [[https://www.atlassian.com/agile/kanban][Kanban]] page -for more information. diff --git a/blog/2023-10-04-digital-minimalism.org b/blog/2023-10-04-digital-minimalism.org deleted file mode 100644 index 36c7718..0000000 --- a/blog/2023-10-04-digital-minimalism.org +++ /dev/null @@ -1,110 +0,0 @@ -#+title: Digital Minimalism -#+date: 2023-10-05 - -I've written [[/notes/minimalism][a note about minimalism]] before, but I wanted to dedicate some time -to reflect on digital minimalism and how I've been able to minimize the impact -of digital devices in my life. - -#+begin_quote -These changes crept up on us and happened fast, before we had a chance to step -back and ask what we really wanted out of the rapid advances of the past -decade. We added new technologies to the periphery of our experience for minor -reasons, then woke one morning to discover that they had colonized the core of -our daily life. We didn't, in other words, sign up for the digital world in -which we're currently entrenched; we seem to have stumbled backward into -it. - -/(Digital Minimalism, 2019)/ -#+end_quote - -** The Principles of Digital Minimalism -:PROPERTIES: -:CUSTOM_ID: the-principles-of-digital-minimalism -:END: -As noted in Cal Newport's book, /Digital Minimalism/, there are three main -principles to digital minimalism that I tend to agree with: - -1. Clutter is costly. - - Digital minimalists recognize that cluttering their time and attention with - too many devices, apps, and services creates an overall negative cost that - can swamp the small benefits that each individual item provides in - isolation. -2. Optimization is important. - - Digital minimalists believe that deciding a particular technology supports - something they value is only the first step. To truly extract its full - potential benefit, it's necessary to think carefully about how they'll use - the technology. -3. Intentionality is satisfying. - - Digital minimalists derive significant satisfaction from their general - commitment to being more intentional about how they engage with new - technologies. This source of satisfaction is independent of the specific - decisions they make and is one of the biggest reasons that minimalism tends - to be immensely meaningful to its practitioners. - -** Taking Action -:PROPERTIES: -:CUSTOM_ID: taking-action -:END: -In order to put the logic into practice, I've created a few new habits and -continued performing old habits that are working well: - -*** Using Devices With Intention -:PROPERTIES: -:CUSTOM_ID: using-devices-with-intention -:END: -- I already rarely use "social media", mostly limited to forums such as Hacker - News and Tildes, so I've just tweaked my behavior to stop looking for content - in those places when I'm bored. -- Use devices with intention. Each time I pick up a digital device, there should - be an intention to use the device to improve my current situation. No more - endless scrolling or searching for something to interest me. - -*** Prevent Distractions -:PROPERTIES: -:CUSTOM_ID: prevent-distractions -:END: -- Disable (most) notifications on all devices. I spent 15-30 minutes going - through the notifications on my phone, watch, and computer to ensure that only - a select few apps have the ability to interrupt me: Calendar, Messages, Phone, - Reminders, & Signal. -- Disable badges for any apps except the ones mentioned in the bullet above. -- Set-up focus profiles across devices so that I can enable different modes, - such as Personal when I only want to see notifications from people I care - about or Do Not Disturb, where absolutely nothing can interrupt me. -- Clean up my home screens. This one was quite easy as I already maintain a - minimalist set-up, but I went extreme by limiting my phone to just eight apps - on the home screen and four in the dock. If I need another app, I'll have to - search or use the app library. -- Remove the work profile from my phone. This was a tough decision as having my - work profile on my device definitely makes my life easier at times, but it - also has quite a negative effect when I'm "always online" and can see the - notifications and team activity 24/7. I believe creating a distinct barrier - between my work and personal devices will be beneficial in the end. - -*** Creating Alternative Activities -:PROPERTIES: -:CUSTOM_ID: creating-alternative-activities -:END: -This is the most difficult piece, as most of my hobbies and interests lie in the -digital world. However, I'm making a concerted effort to put devices down unless -necessary and force myself to perform other activities in the physical world -instead. - -I've started with a few basics that are always readily available to me: - -- Do a chore, such as organizing or cleaning. -- Read a book, study a piece of art, etc. -- Exercise or get outdoors. -- Participate in a hobby, such as photography, birding, disc golf, etc. -- Let yourself be bored and wander into creativity. - -** Making Progress -:PROPERTIES: -:CUSTOM_ID: making-progress -:END: -I'll be taking notes as I continue down this journey and hope to see positive -trends. I've always been a minimalist in the physical world and it feels -refreshing to filter out the clutter that has come to dominate my digital life -over the years. - -I'm excited to see where this journey leads. diff --git a/blog/2023-11-08-scli.org b/blog/2023-11-08-scli.org deleted file mode 100644 index 16c723d..0000000 --- a/blog/2023-11-08-scli.org +++ /dev/null @@ -1,153 +0,0 @@ -#+title: Installing scli on Alpine Linux (musl) -#+date: 2023-11-08 - -[[https://github.com/isamert/scli][scli]] is a command-line tool that allows you to connect to your Signal messenger -account. This program utilizes a two-pane display that shows you chats on the -left and the focused conversation on the right. - -This guide will show you how to install =scli= and its dependencies on Alpine -Linux, which requires some extra work due to musl. - -If you're using a non-musl system, you can likely following the =scli= README -and download the packaged binaries for an easier installation process. - -** Dependencies -:PROPERTIES: -:CUSTOM_ID: dependencies -:END: -In order to use =scli=, you need a few dependencies: - -- =openjdk17-jre= - Used as a dependency for the =signal-cli= tool. - Version may vary. -- =signal-cli= - Used as the backbone of the =scli= tool. -- =findutils= - Replaces the standard Busybox version of =xargs=. -- =urwid= - A console user interface library for Python. -- =urwid-readline= - For GNU emacs-like keybinds on the input line. -- =qrencode= - Displays a QR code in the terminal to link the device - using your phone. Not necessary if you're only linking on desktop and - can copy/paste the connection URL. - -Let's start by installing the packages available via Alpine's -repositories. Be sure to install the latest version of =openjdk=. If you -run into Java-related issues, uninstall =openjdk= and install an older -version. - -#+begin_src sh -doas apk add openjdk17-jre findutils qrencode -#+end_src - -Next, let's install =signal-cli=. Be sure to export the version of -=signal-cli= that you want. I use version =0.12.4= below, but that may -be outdated by the time you're reading this. - -#+begin_src sh -export VERSION="0.12.4" -wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz -doas tar xf signal-cli-"${VERSION}".tar.gz -C /opt -doas ln -sf /opt/signal-cli-${VERSION}"/bin/signal/cli /usr/local/bin -#+end_src - -Finally, install the =urwid= packages using the Python packaging -utility. - -#+begin_src sh -pip3 install urwid urwid-readline -#+end_src - -** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: -Now that we have all of the dependencies we need, we can install =scli=. -Start by simply cloning the repository. - -#+begin_src sh -git clone https://github.com/isamert/scli -#+end_src - -When I cloned this repository on 2023-11-08, I found a bug in the logic -that required a fix. You must edit the =scli= file and replace the one -instance of =RLIMIT_OFILE= with =RLIMIT_NOFILE=. - -#+begin_src sh -cd scli -nano scli -#+end_src - -Once complete, you can move this program to anywhere on your =$PATH=. I -chose the following directory. - -#+begin_src sh -doas mv scli /usr/local/bin/scli -#+end_src - -** Initial Setup -:PROPERTIES: -:CUSTOM_ID: initial-setup -:END: -Now that everything is installed, we can login and configure the client. -Start by generating a connection link. - -#+begin_src sh -signal-cli link -n "YOUR-DEVICE-NICKNAME" | tee >(xargs -L 1 qrencode -t utf8) -#+end_src - -This will generate a connection link and related QR code for you to use -to link the devices together. Once complete, *wait patiently* for the -connection process to finish. - -Once it completes, it will exit and return you to the prompt. From here, -you need to perform an initial =receive= command to start things off. -The =USERNAME= variable should be your phone number, such as -=+15551237890=. - -#+begin_src sh -signal-cli -u USERNAME receive -#+end_src - -Also be sure to test the daemon to ensure it works properly. If no -errors occur, it's working. If you run into errors because you're not -running a DBUS session, see my notes below. - -#+begin_src sh -signal-cli -u USERNAME daemon -#+end_src - -Once the initial reception is complete, you are ready to use =scli=. - -This process will differ depending on your desktop environment (DE). If -you are running a DE, you likely have a DBUS session running already and -can simply launch the program. - -However, if you're like me and running your computer straight on the TTY -without a DE, you'll need to start a DBUS session for this program. - -#+begin_src sh -# If you're not running a DBUS session yet, you need to start one for scli -dbus-run-session -- scli - -# OR - If you're already running a DBUS session, simply run scli -scli -#+end_src - -** Configuration -:PROPERTIES: -:CUSTOM_ID: configuration -:END: -Lastly, there are a number of configuration options that you can pass -via the command or in the =~/.config/sclirc= file. See the Github README -for more information on configuration options. - -#+begin_src sh -nano ~/.config/sclirc -#+end_src - -#+begin_src conf -# ~/.config/sclirc - -wrap-at = 80 -enable-notifications = true -#+end_src - -That's it! Following this guide, I have a functional =scli= program that -successfully sends messages to my contacts and myself! diff --git a/blog/index.org b/blog/index.org deleted file mode 100644 index cbb5ea0..0000000 --- a/blog/index.org +++ /dev/null @@ -1,152 +0,0 @@ -#+title: Blog -#+OPTIONS: toc:nil - -Use =C-f= to search blog post titles for keywords. - -* 2023 -:PROPERTIES: -:ID: 21779F03-E65E-4A80-A958-3D08723EB8AD -:PUBDATE: 2023-12-03 Sun 22:35 -:END: - -- 2023-12-03 [[./2023-12-03-unifi-nextdns.org][How to Install NextDNS on the Unifi Dream Machine]] -- 2023-11-08 [[./2023-11-08-scli.org][Installing scli on Alpine Linux (musl)]] -- 2023-10-17 [[./2023-10-17-self-hosting-anonymousoverflow.org][Self-Hosting AnonymousOverflow]] -- 2023-10-15 [[./2023-10-15-alpine-ssh-hardening.org][SSH Hardening for Alpine Linux]] -- 2023-10-11 [[./2023-10-11-self-hosting-authelia.org][Self-Hosting Authelia]] -- 2023-10-04 [[./2023-10-04-digital-minimalism.org][Digital Minimalism]] -- 2023-09-19 [[./2023-09-19-audit-sql-scripts.org][Useful SQL Scripts for Auditing Logical Access]] -- 2023-09-15 [[./2023-09-15-gitweb.org][Gitweb via Nginx]] -- 2023-08-18 [[./2023-08-18-agile-auditing.org][Agile Auditing: An Introduction]] -- 2023-07-19 [[./2023-07-19-plex-transcoder-errors.org][How to Fix Plex Error: 'Conversion failed. The transcoder failed to start up.']] -- 2023-07-12 [[./2023-07-12-mullvad-wireguard-lan.org][Enabling LAN Access in Mullvad Wireguard Conf Files]] -- 2023-06-30 [[./2023-06-30-self-hosting-voyager-lemmy-client.org][Self Hosting Voyager - A Lemmy Web Client]] -- 2023-06-28 [[./2023-06-28-backblaze-b2.org][Getting Started with Backblaze B2 Cloud Storage]] -- 2023-06-23 [[./2023-06-23-self-hosting-convos-irc.org][Self-Hosting Convos IRC Web Client]] -- 2023-06-23 [[./2023-06-23-byobu.org][Byobu]] -- 2023-06-20 [[./2023-06-20-audit-review-cheatsheet.org][Cheatsheet: Review Audit Test Results]] -- 2023-06-18 [[./2023-06-18-unifi-ip-blocklist.org][Block IP Addresses and Subnets with Unifi Network Firewall]] -- 2023-06-08 [[./2023-06-08-self-hosting-baikal-server.org][Self-Hosting Baïkal Server (CalDAV & CardDAV)]] -- 2023-06-08 [[./2023-06-08-goaccess-geoip.org][Inspecting Nginx Logs with GoAccess and MaxMind GeoIP Data]] -- 2023-05-22 [[./2023-05-22-burnout.org][Burnout]] -- 2023-02-02 [[./2023-02-02-exploring-hare.org][Exploring the Hare Programming Language]] -- 2023-01-28 [[./2023-01-28-self-hosting-wger-workout-manager.org][Self-Hosting Wger Workout Manager]] -- 2023-01-23 [[./2023-01-23-random-mullvad-wireguard.org][Connecting to a Random Mullvad Wireguard Host]] -- 2023-01-21 [[./2023-01-21-running-flatpak-apps-easily.org][Running Flatpak Apps with Symlinks]] -- 2023-01-08 [[./2023-01-08-fedora-remove-login-manager.org][Remove the Login Manager from Fedora i3]] -- 2023-01-05 [[./2023-01-05-mass-unlike-tumblr-posts.org][How to Easily Mass Unlike Tumblr Posts With Javascript]] -- 2023-01-03 [[./2023-01-03-recent-website-changes.org][Recent Website Changes]] - -* 2022 -:PROPERTIES: -:ID: 3B281087-A3B6-46B7-8A29-77F74DAD5F15 -:PUBDATE: 2023-12-03 Sun 22:35 -:END: - -- 2022-12-23 [[./2022-12-23-alpine-desktop.org][Alpine Linux as a Desktop OS]] -- 2022-12-17 [[./2022-12-17-st.org][Simple Terminal]] -- 2022-12-07 [[./2022-12-07-nginx-wildcard-redirect.org][Redirect Nginx Subdomains & Trailing Content with Regex]] -- 2022-12-01 [[./2022-12-01-nginx-compression.org][Enable GZIP Compression on Nginx]] -- 2022-11-29 [[./2022-11-29-nginx-referrer-ban-list.org][Creating a Referrer Ban List on Nginx]] -- 2022-11-27 [[./2022-11-27-server-build.org][Building a Custom Rack-Mount Server]] -- 2022-11-11 [[./2022-11-11-nginx-tmp-errors.org][Fixing Permission Errors in /var/lib/nginx]] -- 2022-11-07 [[./2022-11-07-matrix-synapse.org][Self-Hosting Matrix Synapse on Alpine Linux]] -- 2022-10-30 [[./2022-10-30-linux-display-manager.org][How to Disable or Change the Display Manager on Void Linux]] -- 2022-10-22 [[./2022-10-22-alpine-linux.org][Alpine Linux: My New Server OS]] -- 2022-10-20 [[./2022-10-20-syncthing.org][Syncthing: A Minimal Self-Hosted Cloud Storage Solution]] -- 2022-10-04 [[./2022-10-04-mtp-linux.org][How to Mount an MTP Mobile Device on Linux]] -- 2022-09-21 [[./2022-09-21-graphene-os.org][Installing Graphene OS on the Pixel 6 Pro]] -- 2022-09-17 [[./2022-09-17-serenity-os.org][Serenity OS: Testing Out a Unique System]] -- 2022-08-31 [[./2022-08-31-privacy.com-changes.org][Concerning Changes on Privacy.com]] -- 2022-07-31 [[./2022-07-31-bash-it.org][Upgrade Bash with Bash-It & Ble.sh]] -- 2022-07-30 [[./2022-07-30-flac-to-opus.org][Recursive Command-Line FLAC to Opus Conversion]] -- 2022-07-25 [[./2022-07-25-curseradio.org][CurseRadio: Listening to the Radio on the Command Line]] -- 2022-07-14 [[./2022-07-14-gnupg.org][GNU Privacy Guard (GPG)]] -- 2022-07-01 [[./2022-07-01-git-server.org][Self-Hosting a Personal Git Server]] -- 2022-06-24 [[./2022-06-24-fedora-i3.org][Rebooting My Love Affair with Linux]] -- 2022-06-22 [[./2022-06-22-daily-poetry.org][Daily Plaintext Poetry via Email]] -- 2022-06-16 [[./2022-06-16-terminal-lifestyle.org][A Terminal Lifestyle]] -- 2022-06-07 [[./2022-06-07-freshrss.org][Self-Hosting FreshRSS]] -- 2022-06-04 [[./2022-06-04-njalla-dns-api.org][Dynamic DNS with Njalla API]] -- 2022-06-01 [[./2022-06-01-ditching-cloudflare.org][Ditching Cloudflare for Njalla]] -- 2022-04-09 [[./2022-04-09-pinetime.org][PineTime: An Open-Source SmartWatch]] -- 2022-04-02 [[./2022-04-02-nginx-reverse-proxy.org][Set-Up a Reverse Proxy with Nginx]] -- 2022-03-26 [[./2022-03-26-ssh-mfa.org][Enable TOTP MFA for SSH]] -- 2022-03-24 [[./2022-03-24-server-hardening.org][Hardening a Public-Facing Home Server]] -- 2022-03-23 [[./2022-03-23-nextcloud-on-ubuntu.org][Installing Nextcloud on Ubuntu]] -- 2022-03-23 [[./2022-03-23-cloudflare-dns-api.org][Dynamic DNS with Cloudflare API]] -- 2022-03-08 [[./2022-03-08-plex-migration.org][Migrating Plex to New Server (+ Nvidia Transcoding)]] -- 2022-03-03 [[./2022-03-03-financial-database.org][Maintaining a Personal Financial Database]] -- 2022-03-02 [[./2022-03-02-note-taking.org][Easy, Reliable Note-Taking]] -- 2022-02-22 [[./2022-02-22-tuesday.org][Tuesday]] -- 2022-02-20 [[./2022-02-20-nginx-caching.org][Caching Static Content with Nginx]] -- 2022-02-17 [[./2022-02-17-exiftool.org][Stripping Image Metadata with exiftool]] -- 2022-02-16 [[./2022-02-16-debian-and-nginx.org][Migrating to a New Web Server Setup with Debian, Nginx, and Agate]] -- 2022-02-10 [[./2022-02-10-leaving-the-office.org][Leaving Office-Based Work In the Past]] - -* 2021 -:PROPERTIES: -:ID: 7603D51F-513F-4407-9CDC-F55C555D35D4 -:PUBDATE: 2023-12-03 Sun 22:35 -:END: - -- 2021-12-04 [[./2021-12-04-cisa.org][I Passed the CISA!]] -- 2021-10-09 [[./2021-10-09-apache-redirect.org][Apache Redirect HTML Files to a Directory]] -- 2021-08-25 [[./2021-08-25-audit-sampling.org][Audit Sampling with Python]] -- 2021-07-15 [[./2021-07-15-delete-gitlab-repos.org][How to Delete All GitLab Repositories]] -- 2021-05-30 [[./2021-05-30-changing-git-authors.org][Changing Git Authors]] -- 2021-04-28 [[./2021-04-28-photography.org][Jumping Back Into Photography]] -- 2021-04-23 [[./2021-04-23-php-comment-system.org][Roll Your Own Static Commenting System in PHP]] -- 2021-04-17 [[./2021-04-17-gemini-server.org][Hosting a Gemini Server]] -- 2021-03-30 [[./2021-03-30-vps-web-server.org][How to Set Up a VPS Web Server]] -- 2021-03-28 [[./2021-03-28-vaporwave-vs-outrun.org][Vaporwave vs Outrun]] -- 2021-03-28 [[./2021-03-28-gemini-capsule.org][Launching a Gemini Capsule]] -- 2021-03-19 [[./2021-03-19-clone-github-repos.org][How to Clone All Repositories from a GitHub or Sourcehut Account]] -- 2021-02-19 [[./2021-02-19-macos.org][macOS: Testing Out A New OS]] -- 2021-01-07 [[./2021-01-07-ufw.org][Secure Your Network with the Uncomplicated Firewall]] -- 2021-01-04 [[./2021-01-04-fediverse.org][A Simple Guide to the Fediverse]] -- 2021-01-01 [[./2021-01-01-seum.org][SEUM: Speedrunners from Hell]] - -* 2020 -:PROPERTIES: -:ID: 8442803D-FB00-498D-9936-51029E80B367 -:PUBDATE: 2023-12-03 Sun 22:35 -:END: - -- 2020-12-29 [[./2020-12-29-zork.org][Zork: Let's Explore a Classic]] -- 2020-12-28 [[./2020-12-28-neon-drive.org][Neon Drive: A Nostalgic 80s Arcade Racing Game]] -- 2020-12-27 [[./2020-12-27-website-redesign.org][Redesigning My Website: The 5 KB Result]] -- 2020-10-12 [[./2020-10-12-mediocrity.org][On the Pursuit of Mediocrity]] -- 2020-09-25 [[./2020-09-25-happiness-map.org][Data Visualization: World Choropleth Map of Happiness]] -- 2020-09-22 [[./2020-09-22-internal-audit.org][What is Internal Audit?]] -- 2020-09-01 [[./2020-09-01-visual-recognition.org][IBM Watson Visual Recognition]] -- 2020-08-29 [[./2020-08-29-php-auth-flow.org][PHP Authentication Flow]] -- 2020-08-22 [[./2020-08-22-redirect-github-pages.org][Redirect GitHub Pages from Subdomain to the Top-Level Domain]] -- 2020-07-26 [[./2020-07-26-business-analysis.org][Algorithmically Analyzing Local Businesses]] -- 2020-07-20 [[./2020-07-20-video-game-sales.org][Data Exploration: Video Game Sales]] -- 2020-05-19 [[./2020-05-19-customizing-ubuntu.org][Beginner's Guide: Customizing Ubuntu]] -- 2020-05-03 [[./2020-05-03-homelab.org][An Inside Look at My Homelab]] -- 2020-03-25 [[./2020-03-25-session-messenger.org][Session Private Messenger]] -- 2020-02-09 [[./2020-02-09-cryptography-basics.org][Cryptography Basics]] -- 2020-01-26 [[./2020-01-26-steam-on-ntfs.org][Linux Gaming Tweak: Steam on NTFS Drives]] -- 2020-01-25 [[./2020-01-25-linux-software.org][Linux Software]] - -* 2019 -:PROPERTIES: -:ID: CC0E4E85-6094-48AD-B78A-68DE97E56A17 -:PUBDATE: 2023-12-03 Sun 22:35 -:END: - -- 2019-12-16 [[./2019-12-16-password-security.org][Password Security]] -- 2019-12-03 [[./2019-12-03-the-ansoff-matrix.org][The Ansoff Matrix]] -- 2019-09-09 [[./2019-09-09-audit-analytics.org][Data Analysis in Auditing]] -- 2019-01-07 [[./2019-01-07-useful-css.org][Useful CSS Snippets]] - -* 2018 -:PROPERTIES: -:ID: 4FE32AD6-AC36-43DD-ACEF-B2D98450FB2D -:PUBDATE: 2023-12-03 Sun 22:35 -:END: - -- 2018-12-08 [[./2018-12-08-aes-encryption.org][AES Encryption]] -- 2018-11-28 [[./2018-11-28-cpp-compiler.org][The C++ Compiler]] diff --git a/blog/rss.org b/blog/rss.org deleted file mode 100644 index 79d96f6..0000000 --- a/blog/rss.org +++ /dev/null @@ -1,108 +0,0 @@ -#+TITLE: cleberg.net - -- [[file:2023-12-03-unifi-nextdns.org][How to Install NextDNS on the Unifi Dream Machine]] -- [[file:2021-03-28-vaporwave-vs-outrun.org][2021-03-28-vaporwave-vs-outrun]] -- [[file:2023-06-23-self-hosting-convos-irc.org][2023-06-23-self-hosting-convos-irc]] -- [[file:2020-07-26-business-analysis.org][Algorithmically Analyzing Local Businesses]] -- [[file:2023-07-12-mullvad-wireguard-lan.org][2023-07-12-mullvad-wireguard-lan]] -- [[file:2022-11-11-nginx-tmp-errors.org][2022-11-11-nginx-tmp-errors]] -- [[file:2022-02-16-debian-and-nginx.org][2022-02-16-debian-and-nginx]] -- [[file:2023-06-20-audit-review-cheatsheet.org][2023-06-20-audit-review-cheatsheet]] -- [[file:2020-08-22-redirect-github-pages.org][Redirect GitHub Pages from Subdomain to the Top-Level Domain]] -- [[file:2020-08-29-php-auth-flow.org][PHP Authentication Flow]] -- [[file:2023-05-22-burnout.org][2023-05-22-burnout]] -- [[file:2022-09-21-graphene-os.org][2022-09-21-graphene-os]] -- [[file:2021-04-17-gemini-server.org][2021-04-17-gemini-server]] -- [[file:2023-11-08-scli.org][2023-11-08-scli]] -- [[file:2021-03-28-gemini-capsule.org][2021-03-28-gemini-capsule]] -- [[file:2022-04-09-pinetime.org][2022-04-09-pinetime]] -- [[file:2023-06-08-self-hosting-baikal-server.org][2023-06-08-self-hosting-baikal-server]] -- [[file:2022-07-14-gnupg.org][2022-07-14-gnupg]] -- [[file:2022-12-17-st.org][2022-12-17-st]] -- [[file:2020-05-19-customizing-ubuntu.org][Beginner's Guide: Customizing Ubuntu]] -- [[file:2022-03-23-cloudflare-dns-api.org][2022-03-23-cloudflare-dns-api]] -- [[file:2020-09-25-happiness-map.org][Data Visualization: World Choropleth Map of Happiness]] -- [[file:2022-03-24-server-hardening.org][2022-03-24-server-hardening]] -- [[file:2022-02-22-tuesday.org][2022-02-22-tuesday]] -- [[file:2021-07-15-delete-gitlab-repos.org][2021-07-15-delete-gitlab-repos]] -- [[file:2019-12-03-the-ansoff-matrix.org][The Ansoff Matrix]] -- [[file:2023-06-28-backblaze-b2.org][2023-06-28-backblaze-b2]] -- [[file:2022-12-07-nginx-wildcard-redirect.org][2022-12-07-nginx-wildcard-redirect]] -- [[file:2023-01-05-mass-unlike-tumblr-posts.org][2023-01-05-mass-unlike-tumblr-posts]] -- [[file:2023-01-08-fedora-remove-login-manager.org][2023-01-08-fedora-remove-login-manager]] -- [[file:2018-12-08-aes-encryption.org][AES Encryption]] -- [[file:2020-05-03-homelab.org][An Inside Look at My Homelab]] -- [[file:2023-09-15-gitweb.org][2023-09-15-gitweb]] -- [[file:2022-11-29-nginx-referrer-ban-list.org][2022-11-29-nginx-referrer-ban-list]] -- [[file:2022-03-26-ssh-mfa.org][2022-03-26-ssh-mfa]] -- [[file:2022-12-23-alpine-desktop.org][2022-12-23-alpine-desktop]] -- [[file:2020-01-25-linux-software.org][Linux Software]] -- [[file:2022-02-17-exiftool.org][2022-02-17-exiftool]] -- [[file:2021-12-04-cisa.org][2021-12-04-cisa]] -- [[file:2020-02-09-cryptography-basics.org][Cryptography Basics]] -- [[file:2022-07-30-flac-to-opus.org][2022-07-30-flac-to-opus]] -- [[file:2022-06-24-fedora-i3.org][2022-06-24-fedora-i3]] -- [[file:2020-07-20-video-game-sales.org][Data Exploration: Video Game Sales]] -- [[file:2022-11-07-matrix-synapse.org][2022-11-07-matrix-synapse]] -- [[file:2020-10-12-mediocrity.org][On the Pursuit of Mediocrity]] -- [[file:2021-02-19-macos.org][2021-02-19-macos]] -- [[file:2020-01-26-steam-on-ntfs.org][Linux Gaming Tweak: Steam on NTFS Drives]] -- [[file:2019-01-07-useful-css.org][Useful CSS Snippets]] -- [[file:2023-01-28-self-hosting-wger-workout-manager.org][2023-01-28-self-hosting-wger-workout-manager]] -- [[file:2022-11-27-server-build.org][2022-11-27-server-build]] -- [[file:2023-10-04-digital-minimalism.org][2023-10-04-digital-minimalism]] -- [[file:2020-12-27-website-redesign.org][Redesigning My Website: The 5 KB Result]] -- [[file:2023-09-19-audit-sql-scripts.org][2023-09-19-audit-sql-scripts]] -- [[file:2020-12-28-neon-drive.org][Neon Drive: A Nostalgic 80s Arcade Racing Game]] -- [[file:2023-02-02-exploring-hare.org][2023-02-02-exploring-hare]] -- [[file:2022-09-17-serenity-os.org][2022-09-17-serenity-os]] -- [[file:2021-10-09-apache-redirect.org][2021-10-09-apache-redirect]] -- [[file:2022-03-08-plex-migration.org][2022-03-08-plex-migration]] -- [[file:2023-01-21-running-flatpak-apps-easily.org][2023-01-21-running-flatpak-apps-easily]] -- [[file:2022-06-16-terminal-lifestyle.org][2022-06-16-terminal-lifestyle]] -- [[file:2022-10-22-alpine-linux.org][2022-10-22-alpine-linux]] -- [[file:2019-09-09-audit-analytics.org][Data Analysis in Auditing]] -- [[file:2023-08-18-agile-auditing.org][2023-08-18-agile-auditing]] -- [[file:2023-01-23-random-mullvad-wireguard.org][2023-01-23-random-mullvad-wireguard]] -- [[file:2022-02-20-nginx-caching.org][2022-02-20-nginx-caching]] -- [[file:2022-08-31-privacy.com-changes.org][2022-08-31-privacy.com-changes]] -- [[file:2022-03-02-note-taking.org][2022-03-02-note-taking]] -- [[file:2021-04-28-photography.org][2021-04-28-photography]] -- [[file:2020-09-22-internal-audit.org][What is Internal Audit?]] -- [[file:2022-07-25-curseradio.org][2022-07-25-curseradio]] -- [[file:2022-10-30-linux-display-manager.org][2022-10-30-linux-display-manager]] -- [[file:2022-06-01-ditching-cloudflare.org][2022-06-01-ditching-cloudflare]] -- [[file:2023-06-08-goaccess-geoip.org][2023-06-08-goaccess-geoip]] -- [[file:2019-12-16-password-security.org][Password Security]] -- [[file:2021-01-07-ufw.org][2021-01-07-ufw]] -- [[file:2022-07-01-git-server.org][2022-07-01-git-server]] -- [[file:2023-06-23-byobu.org][2023-06-23-byobu]] -- [[file:2020-03-25-session-messenger.org][Session Private Messenger]] -- [[file:2023-01-03-recent-website-changes.org][2023-01-03-recent-website-changes]] -- [[file:2023-06-30-self-hosting-voyager-lemmy-client.org][2023-06-30-self-hosting-voyager-lemmy-client]] -- [[file:2021-05-30-changing-git-authors.org][2021-05-30-changing-git-authors]] -- [[file:2023-10-11-self-hosting-authelia.org][2023-10-11-self-hosting-authelia]] -- [[file:2021-01-04-fediverse.org][2021-01-04-fediverse]] -- [[file:2021-04-23-php-comment-system.org][2021-04-23-php-comment-system]] -- [[file:2023-07-19-plex-transcoder-errors.org][2023-07-19-plex-transcoder-errors]] -- [[file:2022-07-31-bash-it.org][2022-07-31-bash-it]] -- [[file:2023-10-15-alpine-ssh-hardening.org][2023-10-15-alpine-ssh-hardening]] -- [[file:2022-10-04-mtp-linux.org][2022-10-04-mtp-linux]] -- [[file:2022-06-04-njalla-dns-api.org][2022-06-04-njalla-dns-api]] -- [[file:2022-03-23-nextcloud-on-ubuntu.org][2022-03-23-nextcloud-on-ubuntu]] -- [[file:2021-03-19-clone-github-repos.org][2021-03-19-clone-github-repos]] -- [[file:2022-04-02-nginx-reverse-proxy.org][2022-04-02-nginx-reverse-proxy]] -- [[file:2023-10-17-self-hosting-anonymousoverflow.org][2023-10-17-self-hosting-anonymousoverflow]] -- [[file:2022-06-22-daily-poetry.org][2022-06-22-daily-poetry]] -- [[file:2018-11-28-cpp-compiler.org][The C++ Compiler]] -- [[file:2021-03-30-vps-web-server.org][2021-03-30-vps-web-server]] -- [[file:2021-01-01-seum.org][2021-01-01-seum]] -- [[file:2022-02-10-leaving-the-office.org][2022-02-10-leaving-the-office]] -- [[file:2020-09-01-visual-recognition.org][IBM Watson Visual Recognition]] -- [[file:2023-06-18-unifi-ip-blocklist.org][2023-06-18-unifi-ip-blocklist]] -- [[file:2022-10-20-syncthing.org][2022-10-20-syncthing]] -- [[file:2022-12-01-nginx-compression.org][2022-12-01-nginx-compression]] -- [[file:2022-03-03-financial-database.org][2022-03-03-financial-database]] -- [[file:2021-08-25-audit-sampling.org][2021-08-25-audit-sampling]] -- [[file:2022-06-07-freshrss.org][2022-06-07-freshrss]] -- [[file:2020-12-29-zork.org][Zork: Let's Explore a Classic]]
\ No newline at end of file diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..db53dd3 --- /dev/null +++ b/config.toml @@ -0,0 +1,18 @@ +# Site settings +base_url = "https://cleberg.net" +title = "cleberg.net" +description = "The personal website of Christian Cleberg." +author = "Christian Cleberg" + +# RSS settings +generate_feed = true +feed_filename = "atom.xml" + +[markdown] +highlight_code = true +highlight_theme = "css" +highlight_themes_css = [{ theme = "dracula", filename = "syntax-theme-dark.css" }] +external_links_target_blank = true +lazy_async_image = true + +[extra] diff --git a/content/blog/2018-11-28-cpp-compiler.md b/content/blog/2018-11-28-cpp-compiler.md new file mode 100644 index 0000000..24f8ce8 --- /dev/null +++ b/content/blog/2018-11-28-cpp-compiler.md @@ -0,0 +1,138 @@ ++++ +date = 2018-11-28 +title = "The C++ Compiler" +description = "Learn basics about the C++ compilation process." ++++ + +# A Brief Introduction + +[C++](https://en.wikipedia.org/wiki/C%2B%2B) is a general-purpose +programming language with object-oriented, generic, and functional +features in addition to facilities for low-level memory manipulation. + +The source code, shown in the snippet below, must be compiled before it +can be executed. There are many steps and intricacies to the compilation +process, and this post was a personal exercise to learn and remember as +much information as I can. + +```cpp +#include <iostream> + +int main() +{ + std::cout << "Hello, world!\n"; +} +``` + +# Compilation Process + +## An Overview + +Compiling C++ projects is a frustrating task most days. Seemingly +nonexistent errors keeping your program from successfully compiling can +be annoying (especially since you know you wrote it perfectly the first +time, right?). + +I'm learning more and more about C++ these days and decided to write +this concept down so that I can cement it even further in my own head. +However, C++ is not the only compiled language. Check out [the Wikipedia +entry for compiled +languages](https://en.wikipedia.org/wiki/Compiled_language) for more +examples of compiled languages. + +I'll start with a wonderful, graphical way to conceptualize the C++ +compiler. View [The C++ Compilation +Process](https://web.archive.org/web/20190419035048/http://faculty.cs.niu.edu/~mcmahon/CS241/Notes/compile.html) +by Kurt MacMahon, an NIU professor, to see the graphic and an +explanation. The goal of the compilation process is to take the C++ code +and produce a shared library, dynamic library, or an executable file. + +## Compilation Phases + +Let's break down the compilation process. There are four major steps to +compiling C++ code. + +### Step 1 + +The first step is to expand the source code file to meet all +dependencies. The C++ preprocessor includes the code from all the header +files, such as `#include <iostream>`. Now, what does that +mean? The previous example includes the `iostream` header. +This tells the computer that you want to use the `iostream` +standard library, which contains classes and functions written in the +core language. This specific header allows you to manipulate +input/output streams. After all this, you'll end up which a temporary +file that contains the expanded source code. + +In the example of the C++ code above, the `iostream` class +would be included in the expanded code. + +### Step 2 + +After the code is expanded, the compiler comes into play. The compiler +takes the C++ code and converts this code into the assembly language, +understood by the platform. You can see this in action if you head over +to the [GodBolt Compiler Explorer](https://godbolt.org), which shows C++ +being converted into assembly dynamically. + +For example, the `Hello, world!` code snippet above compiles +into the following assembly code: + +```asm +.LC0: + .string "Hello, world!\n" +main: + push rbp + mov rbp, rsp + mov esi, OFFSET FLAT:.LC0 + mov edi, OFFSET FLAT:_ZSt4cout + call std::basic_ostream<char, std::char_traits<char> >& std::operator<< <std::char_traits<char> >(std::basic_ostream<char, std::char_traits<char> >&, char const*) + mov eax, 0 + pop rbp + ret +__static_initialization_and_destruction_0(int, int): + push rbp + mov rbp, rsp + sub rsp, 16 + mov DWORD PTR [rbp-4], edi + mov DWORD PTR [rbp-8], esi + cmp DWORD PTR [rbp-4], 1 + jne .L5 + cmp DWORD PTR [rbp-8], 65535 + jne .L5 + mov edi, OFFSET FLAT:_ZStL8__ioinit + call std::ios_base::Init::Init() [complete object constructor] + mov edx, OFFSET FLAT:__dso_handle + mov esi, OFFSET FLAT:_ZStL8__ioinit + mov edi, OFFSET FLAT:_ZNSt8ios_base4InitD1Ev + call __cxa_atexit +.L5: + nop + leave + ret +_GLOBAL__sub_I_main: + push rbp + mov rbp, rsp + mov esi, 65535 + mov edi, 1 + call __static_initialization_and_destruction_0(int, int) + pop rbp + ret +``` + +### Step 3 + +Third, the assembly code generated by the compiler is assembled into the +object code for the platform. Essentially, this is when the compiler +takes the assembly code and assembles it into machine code in a binary +format. After researching this online, I figured out that a lot of +compilers will allow you to stop compilation at this step. This would be +useful for compiling each source code file separately. This saves time +later if a single file changes; only that file needs to be recompiled. + +### Step 4 + +Finally, the object code file generated by the assembler is linked +together with the object code files for any library functions used to +produce a shared library, dynamic library, or an executable file. It +replaces all references to undefined symbols with the correct addresses. diff --git a/content/blog/2018-12-08-aes-encryption.md b/content/blog/2018-12-08-aes-encryption.md new file mode 100644 index 0000000..54a31a5 --- /dev/null +++ b/content/blog/2018-12-08-aes-encryption.md @@ -0,0 +1,124 @@ ++++ +date = 2018-12-08 +title = "AES Encryption" +description = "An exploration of the AES encryption standard." ++++ + +# Basic AES + +If you're not familiar with encryption techniques, +[AES](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) is the +**Advanced Encryption Standard**. This specification was established by +the National Institute of Standards and Technology, sub-selected from +the Rijndael family of ciphers (128, 192, and 256 bits) in 2001. +Furthering its popularity and status, the US government chose AES as +their default encryption method for top-secret data, removing the +previous standard which had been in place since 1977. + +AES has proven to be an extremely safe encryption method, with 7-round +and 8-round attacks making no material improvements since the release of +this encryption standard almost two decades ago. + +> Though many papers have been published on the cryptanalysis of AES, +> the fastest single-key attacks on round-reduced AES variants [20, +> 33] so far are only slightly more powerful than those proposed 10 +> years ago [23,24]. +> +> - [Bogdonav, et +> al.](http://research.microsoft.com/en-us/projects/cryptanalysis/aesbc.pdf) + +# How Secure is AES? + +In theory, AES-256 is non-crackable due to the massive number of +combinations that can be produced. However, AES-128 is no longer +recommended as a viable implementation to protect important data. + +A semi-short [comic +strip](http://www.moserware.com/2009/09/stick-figure-guide-to-advanced.html) +from Moserware quickly explains AES for the public to understand. +Basically AES encrypts the data by obscuring the relationship between +the data and the encrypted data. Additionally, this method spreads the +message out. Lastly, the key produced by AES is the secret to decrypting +it. Someone may know the method of AES, but without the key, they are +powerless. + +To obscure and spread the data out, AES creates a +substitution-permutation network. Wikipedia has a wonderful [example of +an SP +network](https://upload.wikimedia.org/wikipedia/commons/thumb/c/cd/SubstitutionPermutationNetwork2.png/468px-SubstitutionPermutationNetwork2.png) +available. This network sends the data through a set of S boxes (using +the unique key) to substitute the bits with another block of bits. Then, +a P box will permutate, or rearrange, the bits. This is done over and +over, with the key being derived from the last round. For AES, the key +size specifies the number of transformation rounds: 10, 12, and 14 +rounds for 128-bit, 192-bit, and 256-bit keys, respectively. + +# The Process + +1. \*KeyExpansion=: Using [Rijndael's key + schedule](https://en.m.wikipedia.org/wiki/Advanced_Encryption_Standard), + the keys are dynamically generated. +2. **AddRoundKey**: Each byte of the data is combined with this key + using bitwise xor. +3. **SubBytes**: This is followed by the substitution of each byte of + data. +4. **ShiftRows**: Then, the final three rows are shifted a certain + number of steps, dictated by the cipher. +5. **MixColumns**: After the rows have been shifted, the columns are + mixed and combined. + +This process does not necessarily stop after one full round. Steps 2 +through 5 will repeat for the number of rounds specified by the key. +However, the final round excludes the MixColumns step. As you can see, +this is a fairly complex process. One must have a solid understanding of +general mathematic principles to fully understand how the sequence works +(and to even attempt to find a weakness). + +According to research done by Bogdanov et al., it would take billions of +years to brute force a 126-bit key with current hardware. Additionally, +this brute force attack would require storing 2^88^ bits of data! +However, there are a few different attacks that have been used to show +vulnerabilities with the use of this technology. Side-channel attacks +use inadvertent leaks of data from the hardware or software, which can +allow attackers to obtain the key or run programs on a user's hardware. + +Please note that this is not something you should run out and try to +implement in your `Hello, World!` app after only a few hours of +research. While AES (basically all encryption methods) is extremely +efficient in what it does, it takes a lot of time and patience to +understand. If you're looking for something which currently implements +AES, check out the [Legion of the Bouncy +Castle](https://www.bouncycastle.org/documentation.html) for Java +implementations of cryptographic algorithms. + +# Why Does Encryption Matter? + +There are limitless reasons to enable encryption at-rest or in-transit +for various aspects of your digital life. You can research specific +examples, such as [Australia passes new law to thwart strong +encryption](https://arstechnica.com/tech-policy/2018/12/australia-passes-new-law-to-thwart-strong-encryption/). +However, I will simply list a few basic reasons to always enable +encryption, where feasible: + +1. Privacy is a human right and is recognized as a national right in + some countries (e.g., [US Fourth + Amendment](https://www.law.cornell.edu/wex/fourth_amendment)). +2. "Why not?" Encryption rarely affects performance or speed, so + there's usually not a reason to avoid it in the first place. +3. Your digital identity and activity (texts, emails, phone calls, + online accounts, etc.) are extremely valuable and can result in + terrible consequences, such as identity theft, if leaked to other + parties. Encrypting this data prevents such leaks from ruining + lives. +4. Wiping or factory-resetting does not actually wipe all data from the + storage device. There are methods to read data from the physical + disks/boards inside devices. +5. Corporations, governments, and other nefarious groups/individuals + are actively looking for ways to collect personal information about + anyone they can. If someone's data is unencrypted, that person may + become a target due to the ease of data collection. + +****Read More:**** + +- [Federal Information Processing Standards Publication + 197](http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.197.pdf) diff --git a/content/blog/2019-01-07-useful-css.md b/content/blog/2019-01-07-useful-css.md new file mode 100644 index 0000000..a3bf5bb --- /dev/null +++ b/content/blog/2019-01-07-useful-css.md @@ -0,0 +1,199 @@ ++++ +date = 2019-01-07 +title = "Useful CSS Snippets" +description = "Explore some useful CSS snippets." ++++ + +# Introduction to CSS + +[CSS](https://en.wikipedia.org/wiki/CSS), the language used to markup +HTML code and make it "pretty", is one of the most effective ways to +increase the attractiveness of a website. It can also lead to increased +user engagement, retention, and satisfaction. In fact, there are whole +career fields are dedicated to the improvement of user experiences, +known as UI design and UX design. + +Some web developers are used to the common CSS properties, such as +element sizing, fonts, colors, etc., but are not as well versed in +less-used properties and values such as `flexbox`, +`clip-path`, and `transform`. This article will +provide some insight into the less-used and unique CSS properties. + +# CSS Variables + +The first topic today is CSS variables. Variables are not often used by +smaller developers. CSS variables allow you to give your website a +well-defined structure, where you can easily reuse CSS properties +throughout the project. + +You can use variables to define things, such as color palettes. Then, +you can use these colors for backgrounds anywhere else in the HTML. This +could be extended, where extra variables could be defined for +`primary-text`, `quoted-text`, etc. Variables can +also be used to define spacing (e.g. `32px` or +`2rem`), which can then be applied to margins, padding, font +sizes, and more. + +For example, here are some variables defined at the root of the website, +which allows for any subsequent CSS rules to use those variables: + +```css +:root { + --primary-color: black; + --secondary-color: white; +} + +body { + background-color: var(--primary-color); + color: var(--secondary-color); +} +``` + +# CSS Box Shadows + +Box shadows were once my mortal enemy. No matter how hard I tried, I +just couldn't get them to work how I wanted. Because of this, my +favorite discovery has been CSSMatic's [box shadow +generator](https://www.cssmatic.com/box-shadow). It provides an +excellent tool to generate box shadows using their simple sliders. +Surprisingly, this is the reason I learned how box shadows work! You can +use the sliders and watch how the CSS code changes in the image that is +displayed. Through this, you should understand that the basic structure +for box shadows is: + +```css +box-shadow: inset horizontal vertical blur spread color; +``` + +Now, let's look at some basic examples! You can copy and paste the +following code into a site like CodePen or your own HTML files. Feel +free to play around with the code, experiment, and learn. + +****Box Shadow #1**** + +```html +<div class="shadow-examples"> + <div class="box effect1"> + <h3>Effect 1</h3> + </div> +</div> +``` + +```css +.box h3 { + text-align: center; + position: relative; + top: 80px; +} +.box { + width: 70%; + height: 200px; + background: #fff; + margin: 40px auto; +} +.effect1 { + box-shadow: 0 10px 6px -6px #777; +} +``` + +****Box Shadow #2**** + +```html +<div class="shadow-examples"> + <div class="box effect2"> + <h3>Effect 2</h3> + </div> +</div> +``` + +```css +.box h3 { + text-align: center; + position: relative; + top: 80px; +} +.box { + width: 70%; + height: 200px; + background: #fff; + margin: 40px auto; +} +.effect2 { + box-shadow: 10px 10px 5px -5px rgba(0, 0, 0, 0.75); +} +``` + +Try these box shadows out on your own and see how changing each shadow +value works. + +# CSS Flexbox + +Now, let's move on to the best part of this article: flexbox. The +flexbox is by far my favorite new toy. I originally stumbled across this +solution after looking for more efficient ways of centering content +horizontally AND vertically. I had used a few hack-ish methods before, +but flexbox throws those out the window. The best part of it all is that +flexbox is *dead simple*. + +Flexbox pertains to the parent div of any element. You want the parent +to be the flexbox in which items are arranged to use the flex methods. +It's easier to see this in action that explained, so let's see an +example. + +****Flexbox**** + +```html +<div class="flex-examples"> + <div class="sm-box"> + <h3>1</h3> + </div> + <div class="sm-box"> + <h3>2</h3> + </div> +</div> +``` + +```css +.flex-examples { + display: flex; + flex-wrap: wrap; + justify-content: flex-start; + align-items: center; + padding: 10px; + background-color: #f2f2f2; +} +.sm-box { + display: flex; + justify-content: center; + align-items: center; + width: 20%; + height: 100px; + background: #fff; + margin: 40px 10px; +} +``` + +You may notice that we no longer need to use the `top` +property for the `h3` elements in our code. This is because +we set the display box to be a flex container for the small boxes, AND +we made the small boxes flex containers for their elements (the h3 +tags). Flex boxes can be nested like this to center content that is +inside centered content. + +For the example above, we designated the `justify-content` +property to be `flex-start` so that the boxes stack from the +left side of the screen. This property can be changed to +`center` to make the boxes appear in the center of the +screen. + +For an interactive example, [check out this +CodePen](https://codepen.io/LandonSchropp/pen/KpzzGo) from +[LandonScropp](https://codepen.io/LandonSchropp/). Resize the window +with dice to see how they collapse and re-align. + +# Even More CSS + +For more inspiration, you can visit [CodePen](https://www.codepen.io), +[Dribbble](https://dribbble.com), or [UI +Movement](https://uimovement.com) to browse the collections of many +amazing web designers. diff --git a/content/blog/2019-09-09-audit-analytics.md b/content/blog/2019-09-09-audit-analytics.md new file mode 100644 index 0000000..141b4e4 --- /dev/null +++ b/content/blog/2019-09-09-audit-analytics.md @@ -0,0 +1,237 @@ ++++ +date = 2019-09-09 +title = "Data Analysis in Auditing" +description = "Learn how to use data analysis in the world of auditing." ++++ + +# What Are Data Analytics? + +A quick aside before I dive into this post: `data analytics` is a +vague term that has become popular in recent years. Think of a `data +analytic` as the output of any data analysis you perform. For example, +a pivot table or a pie chart could be a data analytic. + +[Data analysis](https://en.wikipedia.org/wiki/Data_analysis) is a +process that utilizes statistics and other mathematical methods to +discover useful information within datasets. This involves examining, +cleaning, transforming, and modeling data so that you can use the data +to support an opinion, create more useful viewpoints, and gain knowledge +to implement into audit planning or risk assessments. + +One of the common mistakes that managers (and anyone new to the process) +make is assuming that everything involved with this process is "data +analytics". In fact, data analytics are only a small part of the +process. + +See **Figure 1** for a more accurate representation of where data +analysis sits within the full process. This means that data analysis +does not include querying or extracting data, selecting samples, or +performing audit tests. These steps can be necessary for an audit (and +may even be performed by the same associates), but they are not data +analytics. + + + +# Current Use of Analytics in Auditing + +While data analysis has been an integral part of most businesses and +departments for the better part of the last century, only recently have +internal audit functions been adopting this practice. The internal audit +function works exclusively to provide assurance and consulting services +to the business areas within the firm (except for internal auditing +firms who are hired by different companies to perform their roles). + +> Internal Auditing helps an organization accomplish its objectives by +> bringing a systematic, disciplined approach to evaluate and improve +> the effectiveness of risk management, control and governance +> processes. +> +> - The IIA's Definition of Internal Audit + +Part of the blame for the slow adoption of data analysis can be +attributed to the fact that internal auditing is strongly based on +tradition and following the precedents set by previous auditors. +However, there can be no progress without auditors who are willing to +break the mold and test new audit techniques. In fact, as of 2018, [only +63% of internal audit departments currently utilize data +analytics](https://www.cpapracticeadvisor.com/accounting-audit/news/12404086/internal-audit-groups-are-lagging-in-data-analytics) +in North America. This number should be as close as possible to 100%. I +have never been part of an audit that would not have benefited from data +analytics. + +So, how do internal audit functions remedy this situation? It's +definitely not as easy as walking into work on Monday and telling your +Chief Audit Executive that you're going to start implementing analytics +in the next audit. You need a plan and a system to make the analysis +process as effective as possible. + +# The DELTA Model + +One of the easiest ways to experiment with data analytics and gain an +understanding of the processes is to implement them within your own +department. But how do we do this if we've never worked with analysis +before? One of the most common places to start is to research some data +analysis models currently available. For this post, we'll take a look +at the DELTA model. You can take a look at ****Figure 2**** for a quick +overview of the model. + +The DELTA model sets a few guidelines for areas wanting to implement +data analytics so that the results can be as comprehensive as possible: + +- **Data**: Must be clean, accessible, and (usually) unique. +- **Enterprise-Wide Focus**: Key data systems and analytical resources + must be available for use (by the Internal Audit Function). +- **Leaders**: Must promote a data analytics approach and show the + value of analytical results. +- **Targets**: Must be set for key areas and risks that the analytics + can be compared against (KPIs). +- **Analysts**: There must be auditors willing and able to perform + data analytics or else the system cannot be sustained. + + + +# Finding the Proper KPIs + +Once the Internal Audit Function has decided that they want to start +using data analytics internally and have ensured they're properly set +up to do so, they need to figure out what they will be testing against. +Key Performance Indicators (KPIs) are qualitative or quantitative +factors that can be evaluated and assessed to determine if the +department is performing well, usually compared to historical or +industry benchmarks. Once KPIs have been agreed upon and set, auditors +can use data analytics to assess and report on these KPIs. This allows +the person performing the analytics the freedom to express opinions on +the results, whereas the results are ambiguous if no KPIs exist. + +It should be noted that tracking KPIs in the department can help ensure +you have a rigorous Quality Assurance and Improvement Program (QAIP) in +accordance with some applicable standards, such as IPPF Standard 1300. + +```{=org} +#+BEING_QUOTE +``` +The chief audit executive must develop and maintain a quality assurance +and improvement program that covers all aspects of the internal audit +activity. + +- IPPF Standard 1300 + +```{=org} +#+END_QUOTE +``` +Additionally, IPPF Standard 2060 discusses reporting: + +> The chief audit executive must report periodically to senior +> management and the board on the internal audit activity's purpose, +> authority, responsibility, and performance relative to its plan and on +> its conformance with the Code of Ethics and the Standards. Reporting +> must also include significant risk and control issues, including fraud +> risks, governance issues, and other matters that require the attention +> of senior management and/or the board. +> +> - IPPF Standard 2060 + +The hardest part of finding KPIs is to determine which KPIs are +appropriate for your department. Since every department is different and +has different goals, KPIs will vary drastically between companies. To +give you an idea of where to look, here are some ideas I came up with +when discussing the topic with a few colleagues. + +- Efficiency/Budgeting: + - Audit hours to staff utilization ratio (annual hours divided by + total annual work hours). + - Audit hours compared to the number of audits completed. + - Time between audit steps or to complete the whole audit. E.g., + time from fieldwork completion to audit report issuance. +- Reputation: + - The frequency that management has requested the services of the + IAF. + - Management, audit committee, or external audit satisfaction + survey results. + - Education, experience, certifications, tenure, and training of + the auditors on staff. +- Quality: + - Number and frequency of audit findings. Assign monetary or + numerical values, if possible. + - Percentage of recommendations issued and implemented. +- Planning: + - Percentage or number of key risks audited per year or per audit. + - Proportion of audit universe audited per year. + +# Data Analysis Tools + +Finally, to be able to analyze and report on the data analysis, auditors +need to evaluate the tools at their disposal. There are many options +available, but a few of the most common ones can easily get the job +done. For example, almost every auditor already has access to Microsoft +Excel. Excel is more powerful than most people give it credit for and +can accomplish a lot of basic statistics without much work. If you +don't know a lot about statistics but still want to see some of the +more basic results, Excel is a great option. + +To perform more in-depth statistical analysis or to explore large +datasets that Excel cannot handle, auditors will need to explore other +options. The big three that have had a lot of success in recent years +are Python, R, and ACL. ACL can be used as either a graphical tool +(point and click) or as a scripting tool, where the auditor must write +the scripts manually. Python and the R-language are solely scripting +languages. + +The general trend in the data analytics environment is that if the tool +allows you to do everything by clicking buttons or dragging elements, +you won't be able to fully utilize the analytics you need. The most +robust solutions are created by those who understand how to write the +scripts manually. It should be noted that as the utility of a tool +increases, it usually means that the learning curve for that tool will +also be higher. It will take auditors longer to learn how to utilize +Python, R, or ACL versus learning how to utilize Excel. + +# Visualization + +Once an auditor has finally found the right data, KPIs, and tools, they +must report these results so that actions can be taken. Performing +in-depth data analysis is only useful if the results are understood by +the audiences of the data. The best way to create this understanding is +to visualize the results of the data. Let's take a look at some of the +best options to visualize and report the results you've found. + +Some of the most popular commercial tools for visualization are +Microsoft PowerBI and Tableau Desktop. However, other tools exist such +as JMP, Plotly, Qlikview, Alteryx, or D3. Some require commercial +licenses while others are simply free to use. For corporate data, you +may want to make sure that the tool does not communicate any of the data +outside the company (such as cloud storage). I won't be going into +depth on any of these tools since visualization is largely a subjective +and creative experience, but remember to constantly explore new options +as you repeat the process. + +Lastly, let's take a look at an example of data visualization. This +example comes from a [blog post written by Kushal +Chakrabarti](https://talent.works/2018/03/28/the-science-of-the-job-search-part-iii-61-of-entry-level-jobs-require-3-years-of-experience/) +in 2018 about the percent of entry-level US jobs that require +experience. **Figure 3** shows us an easy-to-digest picture of the data. +We can quickly tell that only about 12.5% of entry-level jobs don't +require experience. + +This is the kind of result that easily describes the data for you. +However, make sure to include an explanation of what the results mean. +Don't let the reader assume what the data means, especially if it +relates to a complex subject. *Tell a story* about the data and why the +results matter. For example, **Figure 4** shows a part of the +explanation the author gives to illustrate his point. + + + + + +# Wrap-Up + +While this is not an all-encompassing program that you can just adopt +into your department, it should be enough to get anyone started on the +process of understanding and implementing data analytics. Always +remember to continue learning and exploring new options as your +processes grow and evolve. diff --git a/content/blog/2019-12-03-the-ansoff-matrix.md b/content/blog/2019-12-03-the-ansoff-matrix.md new file mode 100644 index 0000000..5e8fe05 --- /dev/null +++ b/content/blog/2019-12-03-the-ansoff-matrix.md @@ -0,0 +1,205 @@ ++++ +date = 2019-12-03 +title = "The Ansoff Matrix" +description = "Learn about the Ansoff Matrix, a strategic management tool." ++++ + +# Overview + +As the world of business evolves, managers must approach business +planning and strategy with a contemporary mindset. According to Dess, +McNamara, Eisner, and Lee, managers must be willing to adapt to the +modern business environment by going beyond "'incremental +management', whereby they view their job as making a series of small, +minor changes to improve the efficiency of the firm's operations"[^1]. + +One reason that strategic management is crucial is because most +businesses that fail in the United States each year fail due to a lack +of strategic focus or direction[^2]. The rate of failure for businesses +with poor strategies shows that strategic planning and management are +crucial to a business's strength and longevity, injecting the critical +factors of growth and direction into a company's business plan. + +One of the most significant strategic planning and management frameworks +that companies can use is the [Ansoff +Matrix](https://en.wikipedia.org/wiki/Ansoff_matrix). While this +framework has unique purposes and use-cases, it can effectively help an +organization grow and compete. Specifically, the Ansoff matrix is one of +the most effective frameworks for companies who want to focus on +increasing sales revenue or profitability[^3]. + +This framework uses a two-by-two figure to show the four strategic +options for companies to use in this framework: market penetration, +market development, product development, and diversification (see +**Figure 1**). The x-axis of the matrix focuses on the firm's markets +and also determines if the firm is looking to enter new markets or +innovate in its current markets. The y-axis of the matrix focuses on the +firm's products and determines if the firm wants to pursue strategies +around their existing products or explore new products. + + + +# Strategic Options + +## Market Penetration + +The most straightforward strategy in the Ansoff matrix is to focus on +existing products in existing markets, also known as market +penetration[^4]. Companies such as Coca-Cola have used market +penetration successfully by investing a lot of money to get further +value out of their current markets. Coca-Cola does this by introducing +new features such as Christmas-themed bottles, personal names on the +bottles, and other marketing schemes. + +## Market Development + +Market development extends existing products into new markets in an +attempt to increase the number of buyers. One interesting way that +Coca-Cola used this strategy comes from the stigma that Diet Coke is a +woman's drink[^5]. Coca-Cola introduced Coca-Cola Zero, which contained +the same nutritional content as Diet Coke, but was packaged in a dark +black can to appear more "manly"[^6]. + +## Product Development + +Product development uses existing markets to introduce new products so +that the firm can better meet customer needs[^7]. The extreme end of +diversification is home to companies such as Johnson & Johnson, a +healthcare company that has developed a business portfolio of more than +60,000 different products[^8]. Johnson & Johnson's dedication to +continuous diversification has led them to a balance sheet rating of +"AAA", industry recognition for diversification, and increases in +their investor dividends for 57 consecutive years[^9]. + +## Related Diversification + +Diversification, the final strategy of the Ansoff Matrix, is more +difficult than the others since it involves exploring both new markets +and new products. Related diversification is a diversification strategy +that closely relates to the firm's core business. Coca-Cola's best +example of related diversification is its acquisition of Glaceau and +Vitamin Water, which expanded their drinking lines of business[^10]. + +## Unrelated Diversification + +Unrelated diversification is a diversification strategy that does not +really relate to the firm's core business but still diversifies their +business portfolio. A good example of this would be a coffee company who +has decided to enter the market for bicycle sales. The main purpose of +this strategy is to an extremely diverse company that will not go +bankrupt if one market goes through difficult times. However, this +requires a lot of independent skills and heavy investments since the +company most likely cannot easily transfer knowledge between the markets +they compete in. + +# Requirements for Success + +To use the Ansoff Matrix framework, managers need to formulate corporate +goals and objectives. Without goals and direction, management frameworks +do not present much practical utility. Further, the Ansoff Matrix +requires the managers involved to make tactical decisions and create a +path for the company to take toward their goals. Lastly, both the Ansoff +Matrix needs to consider both internal and external perspectives +throughout the strategy formulation process. + +One interesting probability is that companies will be using multiple +strategic planning and management frameworks at the same time. While +this may sound like it could crowd the management process, there are +numerous reasons to do so. For example, the Ansoff Matrix and the +Balanced Scorecard are relatively popular, and they cover entirely +different parts of a company's strategy. Using the results from the +Balanced Scorecard could inform a company of the potential product and +market demands, such as from customer or supplier survey results, to +help the company determine which Ansoff Matrix strategy to pursue. +However, a combined approach at this level would require mature +frameworks and focused managers who are able to strategize at a high +level. + +Lastly, it should be noted that the author of the Ansoff matrix, Igor +Ansoff, often used the term [paralysis by +analysis](https://en.wikipedia.org/wiki/Analysis_paralysis) to explain +the mistake of companies who overuse analysis and spend too much time +planning. Companies need to understand the utility of a strategic +management framework while ensuring that the company is poised to +execute as efficiently as they have planned. + +# Footnotes + +[^1]: + ```example + Dess, G. G., McNamara, G., Eisner, A. B., Lee, S. H. (2019). Strategic + ``` + + management: Text & cases, ninth edition. New York, NY: McGraw-Hill + Education. + +[^2]: + ```example + Juneja, P. (n.d.). Benefits of strategic management. Management Study + ``` + + Guide. Retrieved from + <https://www.managementstudyguide.com/strategic-management-benefits.htm>. + +[^3]: + ```example + Meldrum M., McDonald M. (1995) The Ansoff matrix. In: Key Marketing + ``` + + Concepts. London: Palgrave. + +[^4]: + ```example + Meldrum M., McDonald M. (1995) The Ansoff matrix. In: Key Marketing + ``` + + Concepts. London: Palgrave. + +[^5]: + ```example + Oakley, T. (2015). Coca-Cola: The Ansoff matrix. The Marketing Agenda. + ``` + + Retrieved from + <https://themarketingagenda.com/2015/03/28/coca-cola-ansoff-matrix/>. + +[^6]: + ```example + Oakley, T. (2015). Coca-Cola: The Ansoff matrix. The Marketing Agenda. + ``` + + Retrieved from + <https://themarketingagenda.com/2015/03/28/coca-cola-ansoff-matrix/>. + +[^7]: + ```example + Oakley, T. (2015). Coca-Cola: The Ansoff matrix. The Marketing Agenda. + ``` + + Retrieved from + <https://themarketingagenda.com/2015/03/28/coca-cola-ansoff-matrix/>. + +[^8]: + ```example + Lemke, T. (2019). The most diversified companies in the stock market. The + ``` + + balance. Retrieved from + <https://www.thebalance.com/the-most-diversified-companies-in-the-stock-market-4169730>. + +[^9]: + ```example + Johnson & Johnson. (2018). 2018 Investor Fact Sheet. [PDF file]. Retrieved + ``` + + from + [http://www.investor.jnj.com/_document/2018-investor-fact-sheet-4-19'id=0000016a-5681-d475-a17f-d78db54a0000](http://www.investor.jnj.com/\_document/2018-investor-fact-sheet-4-19'id=0000016a-5681-d475-a17f-d78db54a0000). + +[^10]: + ```example + Oakley, T. (2015). Coca-Cola: The Ansoff matrix. The Marketing Agenda. + ``` + + Retrieved from + <https://themarketingagenda.com/2015/03/28/coca-cola-ansoff-matrix/>. diff --git a/content/blog/2019-12-16-password-security.md b/content/blog/2019-12-16-password-security.md new file mode 100644 index 0000000..c9c5318 --- /dev/null +++ b/content/blog/2019-12-16-password-security.md @@ -0,0 +1,126 @@ ++++ +date = 2019-12-16 +title = "Password Security" +description = "Password security basics." ++++ + +# Users + +## Why Does It Matter? + +Information security, including passwords and identities, has become one +of the most important digital highlights of the last decade. With +[billions of people affected by data breaches each +year](https://www.usatoday.com/story/money/2018/12/28/data-breaches-2018-billions-hit-growing-number-cyberattacks/2413411002/), +there's a greater need to introduce strong information security +systems. If you think you've been part of a breach, or you want to +check and see, you can use [Have I Been +Pwned](https://haveibeenpwned.com/) to see if your email has been +involved in any public breaches. Remember that there's a possibility +that a company experienced a breach and did not report it to anyone. + +## How Do I Protect Myself? + +The first place to start with any personal security check-up is to +gather a list of all the different websites, apps, or programs that +require you to have login credentials. Optionally, once you know where +your information is being stored, you can sort the list from the +most-important items such as banks or government logins to less +important items such as your favorite meme site. You will want to ensure +that your critical logins are secure before getting to the others. + +Once you think you have a good idea of all your different authentication +methods, I recommend using a password manager such as +[Bitwarden](https://bitwarden.com/). Using a password manager allows you +to automatically save your logins, create randomized passwords, and +transfer passwords across devices. However, you'll need to memorize +your "vault password" that allows you to open the password manager. +It's important to make this something hard to guess since it would +allow anyone who has it to access every password you've stored in +there. + +Personally, I recommend using a +[passphrase](https://en.wikipedia.org/wiki/Passphrase) instead of a +[password](https://en.wikipedia.org/wiki/Password) for your vault +password. Instead of using a string of characters (whether random or +simple), use a phrase and add in symbols and a number. For example, your +vault password could be `Racing-Alphabet-Gourd-Parrot3`. Swap +the symbols out for whichever symbol you want, move the number around, +and fine-tune the passphrase until you are confident that you can +remember it whenever necessary. + +Once you've stored your passwords, make sure you continually check up +on your account and make sure you aren't following bad password +practices. Krebs on Security has a great [blog post on password +recommendations](https://krebsonsecurity.com/password-dos-and-donts/). +Any time that a data breach happens, make sure you check to see if you +were included, and if you need to reset any account passwords. + +# Developers + +## What Are the Basic Requirements? + +When developing any password-protected application, there are a few +basic rules that anyone should follow even if they do not follow any +official guidelines such as NIST. The foremost practice is to require +users to use passwords that are at least 8 characters and cannot easily +be guessed. This sounds extremely simple, but it requires quite a few +different strategies. First, the application should check the potential +passwords against a dictionary of insecure passwords such +`password`, `1234abc`, or +`application_name`. + +Next, the application should offer guidance on the strength of passwords +being entered during enrollment. Further, NIST officially recommends +**not** implementing any composition rules that make passwords hard to +remember (e.g. passwords with letters, numbers, and special characters) +and instead encouraging the use of long pass phrases which can include +spaces. It should be noted that to be able to keep spaces within +passwords, all unicode characters should be supported, and passwords +should not be truncated. + +## What Does NIST Recommend? + +The National Institute of Standards and Technology +([NIST](https://www.nist.gov)) in the US Department of Commerce +regularly publishes information around information security and digital +identity guidelines. Recently, NIST published [Special Publication +800-63b](https://pages.nist.gov/800-63-3/sp800-63b.html): Digital +Identity Guidelines and Authentication and Lifecycle Management. + +> A Memorized Secret authenticator - commonly referred to as a password +> or, if numeric, a PIN - is a secret value intended to be chosen and +> memorized by the user. Memorized secrets need to be of sufficient +> complexity and secrecy that it would be impractical for an attacker to +> guess or otherwise discover the correct secret value. A memorized +> secret is something you know. +> +> - NIST Special Publication 800-63B + +NIST offers a lot of guidance on passwords, but I'm going to highlight +just a few of the important factors: + +- Require passwords to be a minimum of 8 characters (6 characters if + randomly generated and be generated using an approved random bit + generator). +- Compare potential passwords against a list that contains values + known to be commonly-used, expected, or compromised. +- Offer guidance on password strength, such as a strength meter. +- Implement a rate-limiting mechanism to limit the number of failed + authentication attempts for each user account. +- Do not require composition rules for passwords and do not require + passwords to be changed periodically (unless compromised). +- Allow pasting of user identification and passwords to facilitate the + use of password managers. +- Allow users to view the password as it is being entered. +- Use secure forms of communication and storage, including salting and + hashing passwords using a one-way key derivation function. + +NIST offers further guidance on other devices that require specific +security policies, querying for passwords, and more. All the information +discussed so far comes from [NIST +SP800-63b](https://pages.nist.gov/800-63-3/sp800-63b.html) but NIST +offers a lot of information on digital identities, enrollment, identity +proofing, authentication, lifecycle management, federation, and +assertions in the total [NIST SP800-63 Digital Identity +Guidelines](https://pages.nist.gov/800-63-3/). diff --git a/content/blog/2020-01-25-linux-software.md b/content/blog/2020-01-25-linux-software.md new file mode 100644 index 0000000..389e460 --- /dev/null +++ b/content/blog/2020-01-25-linux-software.md @@ -0,0 +1,275 @@ ++++ +date = 2020-01-25 +title = "Linux Software" +description = "A look at some useful Linux applications." ++++ + +# GUI Applications + +## Etcher + + + +[Etcher](https://www.balena.io/etcher/) is a quick and easy way to burn +ISO images to CDs and USB devices. There are two different ways you can +install this program. First, you can navigate to the [official +website](https://www.balena.io/etcher/) and download the AppImage file, +which can run without installation. + +However, AppImage files are not executable by default, so you'll either +need to right-click to open the properties of the file and click the +"Allow executing file as program" box in the Permissions tab or use +the following command: + +```sh +chmod u+x FILE_NAME +``` + +If you don't like AppImage files or just prefer repositories, you can +use the following commands to add the author's repository and install +it through the command-line only. + +First, you'll have to echo the repo and write it to a list file: + +```sh +echo "deb https://deb.etcher.io stable etcher" | sudo tee /etc/apt/sources.list.d/balena-etcher.list +``` + +Next, add the application keys to Ubuntu's keyring: + +```sh +sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 379CE192D401AB61 +``` + +Finally, update the repositories and install the app. + +```sh +sudo apt update && sudo apt install balena-etcher-electron +``` + +Using Arch, Manjaro, or another distro using the AUR? Use this command +instead: + +```sh +sudo pacman -S etcher +``` + +## Atom + + + +[Atom](https://atom.io) is the self-proclaimed "hackable text editor +for the 21st century". This text editor is made by GitHub, [now owned +by +Microsoft](https://news.microsoft.com/2018/06/04/microsoft-to-acquire-github-for-7-5-billion/), +and has some of the best add-ons available to customize the layout and +abilities of the app. + +First, add the Atom repository to your sources. + +```sh +sudo add-apt-repository ppa:webupd8team/atom +``` + +Next, update your package listings and install atom. + +```sh +sudo apt update && sudo apt install atom +``` + +If you have issues updating your packages with the Atom repository, +you'll need to use the snap package described below instead of the +repository. To remove the repository we just added, use this command: + +```sh +sudo add-apt-repository -r ppa:webupd8team/atom +``` + +You can also install Atom as a snap package, but it must be installed +with the `--classic` flag. A [full explanation is +available](https://language-bash.com/blog/how-to-snap-introducing-classic-confinement) +if you'd like to read more about why you need the classic flag. + +```sh +snap install atom --classic +``` + +Using Arch, Manjaro, or another distro using the AUR? Use this command +instead: + +```sh +sudo pacman -S atom +``` + +--- + +## Visual Studio Code + + + +[Visual Studio Code](https://code.visualstudio.com) is yet another +fantastic choice for programming on Linux, especially if you need those +extra add-ons to spice up your late-night coding sessions. The theme +used in the screenshot is +[Mars](https://marketplace.visualstudio.com/items?itemName=EliverLara.mars) +by theme creator [Eliver Lara](https://github.com/EliverLara), who makes +a ton of great themes for VS Code, Atom, and various Linux desktop +environments. + +To install VS Code, you'll need to download the `.deb` file from the +official website. Once you've downloaded the file, either double-click +it to install through the Software Center or run the following command: + +```sh +sudo dpkg -i FILE_NAME.deb +``` + +You can also install VS Code as a snap package, but it must be installed +with the `--classic` flag. A [full explanation is +available](https://language-bash.com/blog/how-to-snap-introducing-classic-confinement) +if you'd like to read more about why you need the classic flag. + +```sh +snap install code --classic +``` + +Using Arch, Manjaro, or another distro using the AUR? Use these commands +instead: + +```sh +sudo pacman -S yay binutils make gcc pkg-config fakeroot yay -S visual-studio-code-bin +``` + +## GNOME Tweaks + + + +[Gnome Tweaks](https://gitlab.gnome.org/GNOME/gnome-tweaks) is the +ultimate tool to use if you want to customize your GNOME desktop +environment. This is how you can switch application themes (GTK), shell +themes, icons, fonts, and more. To install GNOME Tweaks on Ubuntu, you +just need to install the official package. + +```sh +sudo apt install gnome-tweaks +``` + +If you've installed Manjaro or Arch with Gnome, you should have the +tweak tool pre-installed. If you're on Fedora, this tool is available +as an official package: + +```sh +sudo dnf install gnome-tweaks +``` + +## Steam + + + +[Steam](https://steampowered.com) is one of the most popular gaming +libraries for computers and is one of the main reasons that many people +have been able to switch to Linux in recent years, thanks to Steam +Proton, which makes it easier to play games not officially created for +Linux platforms. + +To install Steam on Ubuntu, you just need to install the official +package. + +```sh +sudo apt install steam-installer +``` + +For Arch-based systems, you'll simply need to install the +`steam` package. However, this requires that you enable the +`multilib` source. To do so, use the following command: + +```sh +sudo nano /etc/pacman.conf +``` + +Now, scroll down and uncomment the `multilib` section. + +```config +# Before: +#[multilib] +#Include = /etc/pacman.d/mirrorlist + +# After: +[multilib] +Include = /etc/pacman.d/mirrorlist +``` + +Finally, install the program: + +```sh +sudo pacman -S steam +``` + +[Problem Launching Steam Games? Click +Here.](./2020-01-26-steam-on-ntfs-drives.html) + +# Command-Line Packages + +## neofetch + + + +[Neofetch](https://github.com/dylanaraps/neofetch) is a customizable +tool used in the command-line to show system information. This is +exceptionally useful if you want to see your system's information +quickly without the clutter of some resource-heavy GUI apps. + +This is an official package if you're running Ubuntu 17.04 or later, so +simply use the following command: + +```sh +sudo apt install neofetch +``` + +If you're running Ubuntu 16.10 or earlier, you'll have to use a series +of commands: + +```sh +sudo add-apt-repository ppa:dawidd0811/neofetch; sudo apt update; sudo apt install neofetch +``` + +Using Arch, Manjaro, or another distro using the AUR? Use this command +instead: + +```sh +sudo pacman -S neofetch +``` + +## yt-dlp + + + +[yt-dlp](https://github.com/yt-dlp/yt-dlp) is an extremely handy +command-line tool that allows you to download video or audio files from +various websites, such as YouTube. There are a ton of different options +when running this package, so be sure to run `yt-dlp --help` first to +look through everything you can do (or give up and search for the best +config online). + +While this shouldn't be a problem for most users, yt-dlp requires +Python 2.6, 2.7, or 3.2+ to work correctly, so install Python if you +don't have it already. You can check to see if you have Python +installed by running: + +```sh +python -V +``` + +To get the youtube-dl package, simply curl the URL and output the +results. + +```sh +sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp +``` + +Finally, make the file executable so that it can be run from the +command-line. + +```sh +sudo chmod a+rx /usr/local/bin/yt-dlp +``` diff --git a/content/blog/2020-01-26-steam-on-ntfs.md b/content/blog/2020-01-26-steam-on-ntfs.md new file mode 100644 index 0000000..18b6e8d --- /dev/null +++ b/content/blog/2020-01-26-steam-on-ntfs.md @@ -0,0 +1,95 @@ ++++ +date = 2020-01-26 +title = "Linux Gaming Tweak: Steam on NTFS Drives" +description = "Learn how to fix Steam NTFS issues on Linux." ++++ + +# Auto-Mount Steam Drives + + + +If you want to see how to install Steam on Linux, see my other post: +[Linux Software](/blog/linux-software/). + +Are you having trouble launching games, even though they've installed +correctly? This may happen if you're storing your games on an +NTFS-formatted drive. This shouldn't be an issue if you're storing +your games on the same drive that Steam is on, but some gamers prefer to +put Steam on their main drive and game files on another SSD or HDD. + +To fix this problem, you'll need to try a few things. First, you'll +need to install the `ntfs-3g` package, which is meant for +better interoperability with Linux. + +```sh +sudo apt install ntfs-3g +``` + +Next, you should set up the `/etc/fstab` file to +automatically mount your drives on boot. To automatically mount your +drives when the computer boots up, you'll have to create the folders +you want to mount your drive to first. I store mine in the +`/mnt` folder using names that I'll recognize, but you can +create your folders wherever you want. + +```sh +mkdir /path/to/folder +``` + +For example: + +```sh +mkdir /mnt/steam_library +``` + +To automatically mount drives upon system boot, you will need to collect +a few items. The UUID is the identification number connected to +whichever drive you're using to store Steam games. + +Drives are usually labeled similar to `/dev/nvme0n1p1` or +`/dev/sda1`, so you'll need to find the line in the output +of the command below that correlates to your drive and copy the UUID +over to the `/etc/fstab` file. + +```sh +sudo blkid | grep UUID= +``` + +Next, you'll need your `uid` and `gid`. To find +these, run the following command: + +```sh +id -u && id -g +``` + +Now that you have collected the necessary information, open the +`/etc/fstab` file: + +```sh +sudo nano /etc/fstab +``` + +Each drive you want to mount on boot should have its own line in the +`/etc/fstab` file that looks similar to this: + +```config +UUID=B64E53824E5339F7 /mnt/steam_library ntfs-3g uid=1000,gid=1000 0 0 +``` + +Now all you need to do is unmount your drive and re-mount it. You can +unmount the drive by doing this (be sure to use the correct drive name +here): + +```sh +sudo umount /dev/sdxX +``` + +You can re-mount all your drives by executing the following: + +```sh +sudo mount -a +``` + +If you don't know what your drive name is, or you're nervous about +unmounting and re-mounting, simply reboot your computer, and it will be +done for you automatically. diff --git a/content/blog/2020-02-09-cryptography-basics.md b/content/blog/2020-02-09-cryptography-basics.md new file mode 100644 index 0000000..34e0629 --- /dev/null +++ b/content/blog/2020-02-09-cryptography-basics.md @@ -0,0 +1,178 @@ ++++ +date = 2020-02-09 +title = "Cryptography Basics" +description = "Learn about the basics of cryptography." ++++ + +# Similar Article Available + +If you haven't already, feel free to read my post on [AES +Encryption](/blog/aes-encryption/). + +# What is Cryptography? + +In layman's terms, cryptography is a process that can change data from +a readable format into an unreadable format (and vice-versa) through a +series of processes and secrets. More technically, this is the Internet +Security Glossary's definition: + +> [Cryptography is] the mathematical science that deals with +> transforming data to render its meaning unintelligible (i.e., to hide +> its semantic content), prevent its undetected alteration, or prevent +> its unauthorized use. If the transformation is reversible, +> cryptography also deals with restoring encrypted data to an +> intelligible form. +> +> - [Internet Security Glossary +> (2000)](https://tools.ietf.org/html/rfc2828) + +Cryptography cannot offer protection against the loss of data; it simply +offers encryption methods to protect data at-rest and data in-traffic. +At a high-level, encrypted is when plaintext data is encrypted to +ciphertext (a secure form of text that cannot be understood unless +decrypted back to plaintext). The encryption process is completed +through the use of a mathematical function that utilizes one or more +values called keys to encrypt or decrypt the data. + +# Key Elements of Cryptographic Systems + +To create or evaluate a cryptographic system, you need to know the +essential pieces to the system: + +- **Encryption Algorithm (Primitive):** A mathematical process that + encrypts and decrypts data. +- **Encryption Key:** A string of bits used within the encryption + algorithm as the secret that allows successful encryption or + decryption of data. +- **Key Length (Size):** The maximum number of bits within the + encryption key. It's important to remember that key size is + regulated in many countries. +- **Message Digest:** A smaller, fixed-size bit string version of the + original message. This is practically infeasible to reverse, which + is why it's commonly used to verify integrity. + +# Symmetric Systems (Secret Key Cryptography) + +Symmetric cryptography utilizes a secret, bidirectional key to perform +both encryption and decryption of the data. The most common +implementation of symmetric cryptography is the Advanced Encryption +Standard, which uses keys that are 128 bits to 256 bits in size. This +standard came after the National Institute of Standards and Technology +(NIST) decided to retire the Data Encryption Standard (DES) in 2001. + +Since brute force attacks strongly correlate with key length, the 56-bit +key length of DES was considered insecure after it was publicly broken +in under 24 hours. However, there is a modern implementation of DES +called Triple DES where the DES method is applied three times to each +data block. + +The main advantages to symmetric systems are the ease of use, since only +one key is required for both encryption and decryption, and the +simplicity of the algorithms. This helps with bulk data encryption that +may unnecessarily waste time and power using asymmetric systems. + +However, symmetric systems have disadvantages to keep in mind. Since the +key is private, it can be difficult to safely distribute keys to +communication partners. Additionally, the key cannot be used to sign +messages since it's necessary to keep the key private. + +# Asymmetric Systems (Public Key Cryptography) + +Asymmetric cryptography utilizes two keys within the system: a secret +key that is privately-held and a public key that can be distributed +freely. The interesting aspect of asymmetric cryptography is that either +key can be used to encrypt the data, there's no rule that dictates +which key must be used for encryption. Once one key is used to encrypt +the data, only the other key can be used to decrypt the data. This means +that if the private key encrypts the data, only the public key can +decrypt the data. + +An advantage of this system is that if you successfully decrypt data +using one of the keys, you can be sure of the sender since only the +other key could have encrypted the data. + +One of the major implementations of an asymmetric system is a digital +signature. A digital signature can be generated using the sender's +private key, or a one-way hash function and is used to provide assurance +for the integrity and authenticity of the message. A couple common +message digest algorithms are SHA-256 and SHA-512, which securely +compress data and produce a 128-bit message digest. + +It should be noted that man-in-the-middle attacks are one of the risks +with digital signatures and public keys. To combat this, applications +often use a public key infrastructure (PKI) to independently +authenticate the validity of signatures and keys. + +Due to the large key size and [inefficient mathematical +functions](https://crypto.stackexchange.com/a/591) of asymmetric +encryption, elliptical curve cryptography (ECC) is often used to +increase security while using fewer resources. + +# Applications of Cryptographic Systems + +There are quite a few implementations of cryptographic systems around +the world. Here are a few popular examples: + +**Transport Layer Security (TLS):** One of the most famous cryptographic +solutions created is TLS, a session-layered or connection-layered +internet protocol that allows for secure communications between browsers +and servers. Using handshakes, peer negotiation, and authentication +allows TLS to prevent eavesdropping and malicious transformation of +data. The major reason for TLS popularity is that a major vulnerability +was found in the SSL protocol in 2014. Instead of SSL, TLS can be used +with HTTP to form HTTPS and is the preferred method for modern web +development due to its increased security. + +**Secure Hypertext Transfer Protocol (HTTPS):** An application layer +protocol that allows for secure transport of data between servers and +web clients. One of the unique parts of HTTPS is that it uses a secured +port number instead of the default web port address. + +**Virtual Private Network (VPN):** VPNs are made to securely extend a +private network across public networks by utilizing an encrypted layered +tunneling protocol paired with an authentication method, such as +usernames and passwords. This technology originally allowed remote +employees to access their company's data but have evolved into one of +the top choices for anyone who wishes to mask their sensitive personal +data. + +**Internet Protocol Security (IPSec):** This protocol suite facilitates +communication between two or more hosts or subnets by authenticating and +encrypting the data packets. IPSec is used in a lot of VPNs to establish +the VPN connection through the transport and tunnel mode encryption +methods. IPSec encrypts just the data portion of packets in the +transport methods, but it encrypts both the data and headers in the +tunnel method (introducing an additional header for authentication). + +**Secure Shell (SSH):** SSH is another network protocol used to protect +network services by authenticating users through a secure channel. This +protocol is often used for command-line (shell) functions such as remote +shell commands, logins, and file transfers. + +**Kerberos:** Developed by MIT, Kerberos is a computer-network +authentication protocol that works on the basis of tickets to allow +nodes communicating over a non-secure network to prove their identity to +one another securely. This is most commonly used in business +environments when used as the authentication and encryption method for +Windows Active Directory (AD). + +# Cybersecurity Controls + +If you're someone who needs solutions on how to control risks +associated with utilizing a crytograhpic system, start with a few basic +controls: + +- **Policies:** A policy on the use of cryptographic controls for + protection of information is implemented and is in accordance with + organizational objectives. +- **Key management:** A policy on the use, protection and lifetime of + cryptographic keys is implemented through the entire application + lifecycle. +- **Key size:** The organization has researched the optimal key size + for their purposes, considering national laws, required processing + power, and longevity of the solution. +- **Algorithm selection:** Implemented algorithms are sufficiently + appropriate for the business of the organization, robust, and align + with recommended guidelines. +- **Protocol configuration:** Protocols have been reviewed and + configured suitable to the purpose of the business. diff --git a/content/blog/2020-03-25-session-messenger.md b/content/blog/2020-03-25-session-messenger.md new file mode 100644 index 0000000..627d249 --- /dev/null +++ b/content/blog/2020-03-25-session-messenger.md @@ -0,0 +1,136 @@ ++++ +date = 2020-03-25 +title = "Session Private Messenger" +description = "Exploring the Session Private Messenger application." ++++ + +# Privacy Warning + +The company behind Session (Loki Foundation) is from Australia. If you +didn't know, Australia has introduced +[legislation](https://parlinfo.aph.gov.au/parlInfo/download/legislation/bills/r6195_aspassed/toc_pdf/18204b01.pdf) +mandating companies comply with government requests to build backdoor +access into applications. For more information, read my article on [AES +Encryption](./2020-01-25-aes-encryption.html). + +# About Session + +[Session](https://getsession.org) is a private, cross-platform messaging +app from the [Loki Foundation](https://loki.foundation). As someone who +has spent years looking for quality alternatives to major messaging +apps, I was excited when I first heard about Session. Reading through +[Session's white paper](https://arxiv.org/pdf/2002.04609.pdf), you can +learn the technologies behind the Session app. Part of the security of +Session comes from the Signal protocol, which was forked as the origin +of Session. + +> Session is an end-to-end encrypted messenger that removes sensitive +> metadata collection, and is designed for people who want privacy and +> freedom from any forms of surveillance. + +In general, this app promises security through end-to-end encryption, +decentralized onion routing, and private identities. The biggest change +that the Loki Foundation has made to the Signal protocol is removing the +need for a phone number. Instead, a random identification string is +generated for any session you create. This means you can create a new +session for each device if you want to, or link new devices with your +ID. + +Since Session's website and white paper describe the details of +Session's security, I'm going to focus on using the app in this post. + +# Features + +Since most people are looking for an alternative to a popular chat app, +I am going to list out the features that Session has so that you are +able to determine if the app would suit your needs: + +- Multiple device linking (via QR code or ID) +- App locking via device screen lock, password, or fingerprint +- Screenshot blocking +- Incognito keyboard +- Read receipts and typing indicators +- Mobile notification customization +- Old message deletion and conversation limit +- Backups +- Recovery phrase +- Account deletion, including ID, messages, sessions, and contacts + +# Downloads + +I have tested this app on Ubuntu 19.10, Android 10, macOS Monterey, and +iOS 15. All apps have worked well without many issues. + +Below is a brief overview of the Session app on Linux. To get this app, +you'll need to go to the [Downloads](https://getsession.org/download/) +page and click to link to the operating system you're using. + +For Linux, it will download an AppImage that you'll need to enable with +the following command: + +```sh +sudo chmod u+x session-messenger-desktop-linux-x86_64-1.0.5.AppImage +``` + + + +# Creating an Account + +Once you've installed the app, simply run the app and create your +unique Session ID. It will look something like this: +`05af1835afdd63c947b47705867501d6373f486aa1ae05b1f2f3fcd24570eba608`. + +You'll need to set a display name and, optionally, a password. If you +set a password, you will need to enter it every time you open the app. + + + + + + + +# Start Messaging + +Once you've created your account and set up your profile details, the +next step is to start messaging other people. To do so, you'll need to +share your Session ID with other people. From this point, it's fairly +straightforward and acts like any other messaging app, so I won't dive +into much detail here. + +## macOS + + + +One key feature to note is that the desktop application now provides a +helpful pop-up box explaining the process that Session uses to hide your +IP address: + + + +## iOS + +The mobile app is quite simple and effective, giving you all the +standard mobile messaging options you'd expect. + + + +# Potential Issues + +I've discovered one annoying issue that would prevent from using this +app regularly. On a mobile device, there have been issues with receiving +messages on time. Even with battery optimization disabled and no network +restrictions, Session notifications sometimes do not display until I +open the app or the conversation itself and wait a few moments. This is +actually one of the reasons I stopped using Signal (this seems fixed as +of my updates in 2021/2022, so I wouldn't worry about this issue +anymore). + +Looking for another messenger instead of Session? I recommend Signal, +Matrix, and IRC. diff --git a/content/blog/2020-05-03-homelab.md b/content/blog/2020-05-03-homelab.md new file mode 100644 index 0000000..63a70bb --- /dev/null +++ b/content/blog/2020-05-03-homelab.md @@ -0,0 +1,165 @@ ++++ +date = 2020-05-03 +title = "An Inside Look at My Homelab" +description = "A retrospective on the first iteration of my home lab." ++++ + +# What is a Homelab? + +Starting as a developer, I have largely stayed away from hardware-based +hobbies (other than building a gaming desktop). However, as the +quarantine for COVID-19 stretches out further and further, I found +myself bored and in search of new hobbies. After spending the last few +months browsing the [r/homelab](https://www.reddit.com/r/homelab/) +subreddit, I decided it was time to jump in and try things out for +myself. + +Since I am a beginner and just recently graduated from college, +everything I've done so far in my homelab is fairly low-budget. + +# Hardware + + + +## Raspberry Pi 4 + +Luckily, I had actually purchased a [Raspberry Pi +4](https://www.raspberrypi.org/products/raspberry-pi-4-model-b/) before +the quarantine started so that I could try to keep Plex Media Center +running, even while my desktop computer was turned off. I started here, +using the Pi to hold Plex and Pi-hole until I grew tired with the slow +performance. + +Here are the specifications for the Pi 4: + +- Broadcom BCM2711, Quad core Cortex-A72 (ARM v8) 64-bit SoC @ 1.5GHz +- 4GB LPDDR4-3200 SDRAM +- Gigabit Ethernet +- H.265 (4kp60 decode), H264 (1080p60 decode, 1080p30 encode) +- 64 GB MicroSD Card + +## Dell Optiplex 5040 + +Since I wasn't happy with the Pi as my main server, I turned to +Craigslist. I know a lot of other homelabbers use Ebay, but I can't +seem to ever trust it enough to purchase items on there. So I used +Craigslist and found a Dell Optiplex 5040 desktop computer on sale for +\$90. While this computer might be underpowered, it was one of the few +computers under \$100 that was available during quarantine. + +Here are the specifications for the Dell Optiplex 5040: + +- Intel Core i3 6100 +- 8GB RAM DDR3 +- Intel HD Graphics +- Gigabit Ethernet +- 500GB Hard Drive + +While this hardware would be awful for a work computer or a gaming rig, +it turned out to be wonderful for my server purposes. The only +limitation I have found so far is the CPU. The i3-6100 only has enough +power for a single 4k video transcode at a time. I haven't tested more +than three 1080p streams at a time, but the maximum amount of streams +I've ever actually used is two. + +## WD easystore 10TB & 8TB + +Application storage and temporary files are stored on the internal hard +drive of the server, but all media files (movies, tv, games, books, etc) +are stored externally on my WD easystore hard drive. Creating auto-boot +configurations in the `/etc/fstab` file on my server allows +the hard drives to automatically mount whenever I need to restart my +server. + +> Update: In March 2022, I shucked the hard drives out of their external +> cases, put some Kapton tape on the third power pin to prevent power +> shutdowns, and stuck them inside my server tower using internal SATA +> cables. + +## Netgear Unmanaged Switch + +To manage all the ethernet cords used by my homelab, my desktop, and my +living room media center, I purchased an 8-port gigabit ethernet switch +for \$50 at my local computer store. This is probably much more than I +should have spent on an unmanaged switch, but I am comfortable with the +choice. + +## TP-Link Managed Switch + +Since I use the unmanaged switch to group all living room devices +together, I use the managed switch to configure VLANs and secure my +network. + +## Arris TM1602A Modem & Sagecom Fast 5280 Router + +My default modem and router, provided by my ISP, are fairly standard. +The Arris modem supports DOCSIS 3.0, which is something that I +definitely wanted as a minimum. The Sagecom router is also standard, no +fancy bells or whistles. However, it does support DHCP and DHCPv6, which +is something you can use to route all household traffic through a +pi-hole or firewall. + +## TP-Link EAP + +In order to gain better control over the network, I use my own wireless +access point instead of the one included in the Sagecom router above. +Now I can control and organize all of my ethernet connections through +the VLANs on the managed switch and wireless connections through the +VLANS on the EAP. + +## Generic Printer + +The last piece to my homelab is a standard wireless printer. Nothing +special here. + +# Software + +## Ubuntu Server 20.04 + +While the 20.04 version of Ubuntu was just released, I always like to +experiment with new features (and I don't mind breaking my system - it +just gives me more experience learning how to fix things). So, I have +Ubuntu Server 20.04 installed on the Dell Optiplex server and Ubuntu +Server 19.10 installed on the Raspberry Pi. Once I find an acceptable +use for the Pi, I will most likely switch the operating system. + +## Docker + +I am *very* new to Docker, but I have had a lot of fun playing with it +so far. Docker is used to create containers that can hold all the +contents of a system without interfering with other software on the same +system. So far, I have successfully installed pi-hole, GitLab, Gogs, and +Nextcloud in containers. However, I opted to delete all of those so that +I can reconfigure them more professionally at a later time. + +## Plex Media Server + +Plex is a media center software that allows you to organize your movies, +TV shows, music, photos, and videos automatically. It will even download +metadata for you so that you can easily browse these collections. + +## Pi-hole + +Pi-hole is an alternative ad-blocker that runs at the DNS level, +allowing you to block traffic when it hits your network, so that you can +reject any traffic you deem to be bad. Pi-hole uses blacklists and +whitelists to decide which traffic block and, luckily, there are a lot +of pre-made lists out there on Reddit, GitHub, etc. + +## Nextcloud + +While I had trouble with the Docker version of Nextcloud, I was very +successful when setting up the snap version. Using this, I was able to +map Nextcloud to a subdomain of a domain I own in Namecheap. +Additionally, Nextcloud has an integration with Let's Encrypt that +allows me to issue certificates automatically to any new domain I +authorize. + +## Webmin + +To monitor my servers, and the processes running on them, I use the +Webmin dashboard. This was fairly painless to set up, and I currently +access it straight through the server's IP address. In the future, I +will be looking to configure Webmin to use a custom domain just like +Nextcloud. diff --git a/content/blog/2020-05-19-customizing-ubuntu.md b/content/blog/2020-05-19-customizing-ubuntu.md new file mode 100644 index 0000000..895a29a --- /dev/null +++ b/content/blog/2020-05-19-customizing-ubuntu.md @@ -0,0 +1,210 @@ ++++ +date = 2020-05-19 +title = "Beginner's Guide: Customizing Ubuntu" +description = "A beginner's guide to customizing the Ubuntu operating system." ++++ + +# More Information + +For inspiration on designing your *nix computer, check out the +[r/unixporn](https://libredd.it/r/unixporn) subreddit! + +# Customizing Ubuntu + +New to Linux and want to add a personal touch to your machine? One of +the best perks of Linux is that it is **extremely** customizable. You +can change the styles of the windows, shell (status bars/docks), icons, +fonts, terminals, and more. + +In this post, I'm going to go through customization on Ubuntu 20.04 +(GNOME) since most new users tend to choose Ubuntu-based distros. If +you've found a way to install Arch with i3-gaps, I'm assuming you know +how to find more advanced tutorials out there on customizations. + +## Required Tools + + + +Ubuntu 20.04 ships with the default desktop environment +[Gnome](https://www.gnome.org/), which includes the handy +`gnome-tweaks` tool to quickly change designs. To install +this, just open your terminal and enter the following command: + +```sh +sudo apt install gnome-tweaks +``` + +After you've finished installing the tool, simply launch the Tweaks +application, and you'll be able to access the various customization +options available by default on Ubuntu. You might even like some of the +pre-installed options. + +## GNOME Application Themes + +To change the themes applied to applications in GNOME, you will need to +change the Applications dropdown in the Appearance section of Tweaks. To +add more themes, you will have to find your preferred theme online and +follow the steps below to have it show up in the Tweaks tool. While you +may find themes anywhere, one of the most popular sites for GNOME themes +is [gnome-look.org](https://www.gnome-look.org/). This website contains +themes for applications, shells, icons, and cursors. + +Steps to import themes into Tweaks: + +1. Download the theme. +2. These files are usually compressed (.zip, .tar.gz, .tar.xz), so you + will need to extract the contents. This is easiest when opening the + file explorer, right-clicking the compressed file, and choosing + "Extract here." +3. Move the theme folder to `/usr/share/themes/`. You can do + so with the following command: + `sudo mv theme-folder/ /usr/share/themes/`. + - Icons and cursors will be moved to the + `/usr/share/icons/` folder. + - Fonts will be moved to the `/usr/share/fonts/` folder + Alternatively, you can move them to the + `/usr/share/fonts/opentype/` or + `/usr/share/fonts/opentype/` folders, if you have a + specific font type. +4. Close tweaks if it is open. Re-open Tweaks and your new theme will + be available in the Applications dropdown in the Appearance section + of Tweaks. + +If the theme is not showing up after you've moved it into the themes +folder, you may have uncompressed the folder into a sub-folder. You can +check this by entering the theme folder and listing the contents: + +```sh +cd /usr/share/themes/Mojave-Dark && ls -la +``` + +This is an example of what the contents of your theme folder should look +like. If you just see another folder there, you should move that folder +up into the `/usr/share/themes/` folder. + +```sh +cinnamon COPYING gnome-shell gtk-2.0 gtk-3.0 index.theme metacity-1 plank xfwm4 +``` + +## GNOME Shell Themes + +To change the appearance of the title bar, default dock, app menu, and +other parts of the GNOME shell, you'll need to install the [user +themes](https://extensions.gnome.org/extension/19/user-themes/) +extension on [Gnome Extensions](https://extensions.gnome.org/). To be +able to install extensions, you will first need to install the browser +extension that the website instructs you to. See this screenshot for the +blue box with a link to the extension. + + + +After the browser extension is installed, you will need to install the +native host connector: + +```sh +sudo apt install chrome-gnome-shell +``` + +Finally, you can go the [user +themes](https://extensions.gnome.org/extension/19/user-themes/) +extension page and click the installation button. This will enable the +Shell option in Tweaks. Now you can move shell themes to the +`/usr/share/themes` directory, using the same steps mentioned +in the previous section, and enable the new theme in Tweaks. + +## Icons & Cursors + +Icons and cursors are installed exactly the same way, so I'm grouping +these together in this post. Both of these items will need to follow the +same process as installing themes, except you will want to move your +font folders to the `/usr/share/icons/` directory instead. + +## Fonts + +Fonts are one of the overlooked parts of customization, but a good font +can make the whole screen look different. For example, I have installed +the [IBM Plex](https://github.com/IBM/plex/releases) fonts on my system. +This follows the same process as installing themes, except you will want +to move your font folders to the `/usr/share/fonts/` +directory instead. + +## Terminal + +If you spend a lot of time typing commands, you know how important the +style and functionality of the terminal is. After spending a lot of time +using the default GNOME terminal with [unix +shell](https://en.wikipedia.org/wiki/Bash_(Unix_shell)), I decided to +try some different options. I ended up choosing +[Terminator](https://terminator-gtk3.readthedocs.io/en/latest/) with +[zsh](https://en.wikipedia.org/wiki/Z_shell). + +Terminator is great if you need to open multiple terminals at one time +by simply right-clicking and splitting the screen into as many terminals +as you want. While this project hasn't been updated in a while, [it is +coming under new +development](https://github.com/gnome-terminator/terminator/issues/1). +However, this terminal is great and I haven't experienced any errors +yet. + +For the shell choice, I decided to choose zsh after trying it out on a +fresh Manjaro installation. Zsh is great if you like to change the +themes of your terminal, include icons, or add plugins. + +The desktop uses the +[zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) +to suggest past commands as you type. In addition, it suggests +corrections if you misspell a command. Lastly, it uses the +`af-magic` theme, which adds dashed lines between commands, +moving the user@host tag to the right side of the terminal, and changes +the colors. There are plenty of plugins and themes to choose from. Just +figure out what you like and add it to your `~/.zshrc` file! + +### Steps to Replicate My Terminal + +To install zsh on Ubuntu, enter the following command into a terminal: + +```sh +sudo apt install zsh +``` + +Then, enter the next command to activate zsh: + +```sh +sudo chsh -s $(which zsh) $(whoami) +``` + +To install Terminator on Ubuntu: + +```sh +sudo apt install terminator +``` + +To install Oh My Zsh on Ubuntu: + +```sh +sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" +``` + +To install zsh-autosuggestions via Oh My Zsh: + +```sh +git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions +``` + +Then, add the following plugin wording to your `~/.zshrc` +file (the default config usually has the `git` plugin +activated, so just add any other plugins to the parentheses separated by +a space): + +```sh +nano ~/.zshrc +``` + +```sh +plugins=(git zsh-autosuggestions) +``` + +Finally, you need to log out of your computer and log back in so your +user shell can refresh. diff --git a/content/blog/2020-07-20-video-game-sales.md b/content/blog/2020-07-20-video-game-sales.md new file mode 100644 index 0000000..bff90a8 --- /dev/null +++ b/content/blog/2020-07-20-video-game-sales.md @@ -0,0 +1,181 @@ ++++ +date = 2020-07-20 +title = "Data Exploration: Video Game Sales" +description = "Exploring and visualizing data with Python." ++++ + +# Background Information + +This dataset (obtained from +[Kaggle](https://www.kaggle.com/gregorut/videogamesales/data)) contains +a list of video games with sales greater than 100,000 copies. It was +generated by a scrape of vgchartz.com. + +Fields include: + +- Rank: Ranking of overall sales +- Name: The game name +- Platform: Platform of the game release (i.e. PC,PS4, etc.) +- Year: Year of the game's release +- Genre: Genre of the game +- Publisher: Publisher of the game +- NA~Sales~: Sales in North America (in millions) +- EU~Sales~: Sales in Europe (in millions) +- JP~Sales~: Sales in Japan (in millions) +- Other~Sales~: Sales in the rest of the world (in millions) +- Global~Sales~: Total worldwide sales. + +There are 16,598 records. 2 records were dropped due to incomplete +information. + +# Import the Data + +```python +# Import the Python libraries we will be using +import pandas as pd +import numpy as np +import seaborn as sns; sns.set() +import matplotlib.pyplot as plt + +# Load the file using the path to the downloaded file +file = r'video_game_sales.csv' +df = pd.read_csv(file) +df +``` + + + +# Explore the Data + +```python +# With the description function, we can see the basic stats. For example, we can also see that the 'Year' column has some incomplete values. +df.describe() +``` + + + +```python +# This function shows the rows and columns of NaN values. For example, df[179,3] = nan +np.where(pd.isnull(df)) + +(array([179, ..., 16553], dtype=int64), + array([3, ..., 5], dtype=int64)) +``` + +# Visualize the Data + +```python +# This function plots the global sales by platform +sns.catplot(x='Platform', y='Global_Sales', data=df, jitter=False).set_xticklabels(rotation=90) +``` + + + +```python +# This function plots the global sales by genre +sns.catplot(x='Genre', y='Global_Sales', data=df, jitter=False).set_xticklabels(rotation=45) +``` + + + +```python +# This function plots the global sales by year +sns.lmplot(x='Year', y='Global_Sales', data=df).set_xticklabels(rotation=45) +``` + + + +```python +# This function plots four different lines to show sales from different regions. +# The global sales plot line is commented-out, but can be included for comparison +df2 = df.groupby('Year').sum() +years = range(1980,2019) + +a = df2['NA_Sales'] +b = df2['EU_Sales'] +c = df2['JP_Sales'] +d = df2['Other_Sales'] +# e = df2['Global_Sales'] + +fig, ax = plt.subplots(figsize=(12,12)) +ax.set_ylabel('Region Sales (in Millions)') +ax.set_xlabel('Year') + +ax.plot(years, a, label='NA_Sales') +ax.plot(years, b, label='EU_Sales') +ax.plot(years, c, label='JP_Sales') +ax.plot(years, d, label='Other_Sales') +# ax.plot(years, e, label='Global_Sales') + +ax.legend() +plt.show() +``` + + + +# Investigate Outliers + +```python +# Find the game with the highest sales in North America +df.loc[df['NA_Sales'].idxmax()] + +Rank 1 +Name Wii Sports +Platform Wii +Year 2006 +Genre Sports +Publisher Nintendo +NA_Sales 41.49 +EU_Sales 29.02 +JP_Sales 3.77 +Other_Sales 8.46 +Global_Sales 82.74 +Name: 0, dtype: object + +# Explore statistics in the year 2006 (highest selling year) +df3 = df[(df['Year'] == 2006)] +df3.describe() +``` + + + +```python +# Plot the results of the previous dataframe (games from 2006) - we can see the year's results were largely carried by Wii Sports +sns.catplot(x="Genre", y="Global_Sales", data=df3, jitter=False).set_xticklabels(rotation=45) +``` + + + +```python +# We can see 4 outliers in the graph above, so let's get the top 5 games from that dataframe +# The results below show that Nintendo had all top 5 games (3 on the Wii and 2 on the DS) +df3.sort_values(by=['Global_Sales'], ascending=False).head(5) +``` + + + +# Discussion + +The purpose of exploring datasets is to ask questions, answer questions, +and discover intelligence that can be used to inform decision-making. +So, what have we found in this dataset? + +Today we simply explored a publicly-available dataset to see what kind +of information it contained. During that exploration, we found that +video game sales peaked in 2006. That peak was largely due to Nintendo, +who sold the top 5 games in 2006 and has a number of games in the top-10 +list for the years 1980-2020. Additionally, the top four platforms by +global sales (Wii, NES, GB, DS) are owned by Nintendo. + +We didn't explore everything this dataset has to offer, but we can tell +from a brief analysis that Nintendo seems to rule sales in the video +gaming world. Further analysis could provide insight into which genres, +regions, publishers, or world events are correlated with sales. diff --git a/blog/2020-07-26-business-analysis.org b/content/blog/2020-07-26-business-analysis.md index 4339eee..dd913e6 100644 --- a/blog/2020-07-26-business-analysis.org +++ b/content/blog/2020-07-26-business-analysis.md @@ -1,28 +1,31 @@ -#+date: 2020-07-26 -#+title: Algorithmically Analyzing Local Businesses ++++ +date = 2020-07-26 +title = "Algorithmically Analyzing Local Businesses" +description = "Exploring and visualizing data with Python." ++++ -* Background Information +# Background Information -This project aims to help investors learn more about a random city in order to -determine optimal locations for business investments. The data used in this -project was obtained using Foursquare's developer API. +This project aims to help investors learn more about a random city in +order to determine optimal locations for business investments. The data +used in this project was obtained using Foursquare's developer API. Fields include: -- Venue Name -- Venue Category -- Venue Latitude -- Venue Longitude +- Venue Name +- Venue Category +- Venue Latitude +- Venue Longitude -There are 232 records found using the center of Lincoln as the area of interest -with a radius of 10,000. +There are 232 records found using the center of Lincoln as the area of +interest with a radius of 10,000. -* Import the Data +# Import the Data -The first step is the simplest: import the applicable libraries. We will be -using the libraries below for this project. +The first step is the simplest: import the applicable libraries. We will +be using the libraries below for this project. -#+BEGIN_SRC python +```python # Import the Python libraries we will be using import pandas as pd import requests @@ -31,32 +34,32 @@ import math import json from pandas.io.json import json_normalize from sklearn.cluster import KMeans -#+END_SRC +``` -To begin our analysis, we need to import the data for this project. The data we -are using in this project comes directly from the Foursquare API. The first step -is to get the latitude and longitude of the city being studied (Lincoln, NE) and -setting up the folium map. +To begin our analysis, we need to import the data for this project. The +data we are using in this project comes directly from the Foursquare +API. The first step is to get the latitude and longitude of the city +being studied (Lincoln, NE) and setting up the folium map. -#+BEGIN_SRC python +```python # Define the latitude and longitude, then map the results latitude = 40.806862 longitude = -96.681679 map_LNK = folium.Map(location=[latitude, longitude], zoom_start=12) map_LNK -#+END_SRC +``` -#+CAPTION: Blank Map -[[https://img.cleberg.net/blog/20200726-ibm-data-science/01_blank_map-min.png]] + -Now that we have defined our city and created the map, we need to go get the -business data. The Foursquare API will limit the results to 100 per API call, so -we use our first API call below to determine the total results that Foursquare -has found. Since the total results are 232, we perform the API fetching process -three times (100 + 100 + 32 = 232). +Now that we have defined our city and created the map, we need to go get +the business data. The Foursquare API will limit the results to 100 per +API call, so we use our first API call below to determine the total +results that Foursquare has found. Since the total results are 232, we +perform the API fetching process three times (100 + 100 + 32 = 232). -#+BEGIN_SRC python +```python # Foursquare API credentials CLIENT_ID = 'your-client-id' CLIENT_SECRET = 'your-client-secret' @@ -114,18 +117,19 @@ url3 = 'https://api.foursquare.com/v2/venues/explore?&client_id={}&client_secret # Fetch the final results (201 - 232) results3 = requests.get(url3).json() -#+END_SRC +``` -* Clean the Data +# Clean the Data -Now that we have our data in three separate dataframes, we need to combine them -into a single dataframe and make sure to reset the index so that we have a -unique ID for each business. The `get_category_type` function below will pull -the categories and name from each business's entry in the Foursquare data -automatically. Once all the data has been labeled and combined, the results are -stored in the =nearby_venues= dataframe. +Now that we have our data in three separate dataframes, we need to +combine them into a single dataframe and make sure to reset the index so +that we have a unique ID for each business. The `get~categorytype~` +function below will pull the categories and name from each business's +entry in the Foursquare data automatically. Once all the data has been +labeled and combined, the results are stored in the +`nearby_venues` dataframe. -#+BEGIN_SRC python +```python # This function will extract the category of the venue from the API dictionary def get_category_type(row): try: @@ -188,18 +192,18 @@ nearby_venues3.columns = [col.split(".")[-1] for col in nearby_venues3.columns] nearby_venues = nearby_venues.append(nearby_venues3) nearby_venues = nearby_venues.reset_index(drop=True) nearby_venues -#+END_SRC +``` -#+CAPTION: Clean Data -[[https://img.cleberg.net/blog/20200726-ibm-data-science/02_clean_data-min.png]] + -* Visualize the Data +# Visualize the Data -We now have a complete, clean data set. The next step is to visualize this data -onto the map we created earlier. We will be using folium's =CircleMarker()= -function to do this. +We now have a complete, clean data set. The next step is to visualize +this data onto the map we created earlier. We will be using folium's +`CircleMarker()` function to do this. -#+BEGIN_SRC python +```python # add markers to map for lat, lng, name, categories in zip(nearby_venues['lat'], nearby_venues['lng'], nearby_venues['name'], nearby_venues['categories']): label = '{} ({})'.format(name, categories) @@ -215,22 +219,25 @@ for lat, lng, name, categories in zip(nearby_venues['lat'], nearby_venues['lng'] ).add_to(map_LNK) map_LNK -#+END_SRC +``` - +\![Initial data +map](<https://img.cleberg.net/blog/20200726-ibm-data-science/03_data_map-min.png> +"Initial data map") -* Clustering: /k-means/ +# Clustering: *k-means* -To cluster the data, we will be using the /k-means/ algorithm. This algorithm is -iterative and will automatically make sure that data points in each cluster are -as close as possible to each other, while being as far as possible away from -other clusters. +To cluster the data, we will be using the *k-means* algorithm. This +algorithm is iterative and will automatically make sure that data points +in each cluster are as close as possible to each other, while being as +far as possible away from other clusters. -However, we first have to figure out how many clusters to use (defined as the -variable /'k'/). To do so, we will use the next two functions to calculate the -sum of squares within clusters and then return the optimal number of clusters. +However, we first have to figure out how many clusters to use (defined +as the variable *'k'*). To do so, we will use the next two functions +to calculate the sum of squares within clusters and then return the +optimal number of clusters. -#+BEGIN_SRC python +```python # This function will return the sum of squares found in the data def calculate_wcss(data): wcss = [] @@ -264,13 +271,13 @@ def optimal_number_of_clusters(wcss): # calculating the optimal number of clusters n = optimal_number_of_clusters(sum_of_squares) -#+END_SRC +``` -Now that we have found that our optimal number of clusters is six, we need to -perform k-means clustering. When this clustering occurs, each business is -assigned a cluster number from 0 to 5 in the dataframe. +Now that we have found that our optimal number of clusters is six, we +need to perform k-means clustering. When this clustering occurs, each +business is assigned a cluster number from 0 to 5 in the dataframe. -#+BEGIN_SRC python +```python # set number of clusters equal to the optimal number kclusters = n @@ -279,12 +286,13 @@ kmeans = KMeans(n_clusters=kclusters, random_state=0).fit(cluster_df) # add clustering labels to dataframe nearby_venues.insert(0, 'Cluster Labels', kmeans.labels_) -#+END_SRC +``` -Success! We now have a dataframe with clean business data, along with a cluster -number for each business. Now let's map the data using six different colors. +Success! We now have a dataframe with clean business data, along with a +cluster number for each business. Now let's map the data using six +different colors. -#+BEGIN_SRC python +```python # create map with clusters map_clusters = folium.Map(location=[latitude, longitude], zoom_start=12) colors = ['#0F9D58', '#DB4437', '#4285F4', '#800080', '#ce12c0', '#171717'] @@ -303,36 +311,37 @@ for lat, lng, name, categories, cluster in zip(nearby_venues['lat'], nearby_venu fill_opacity=0.7).add_to(map_clusters) map_clusters -#+END_SRC +``` -#+CAPTION: Clustered Map -[[https://img.cleberg.net/blog/20200726-ibm-data-science/04_clusters-min.png]] + -* Investigate Clusters +# Investigate Clusters -Now that we have figured out our clusters, let's do a little more analysis to -provide more insight into the clusters. With the information below, we can see -which clusters are more popular for businesses and which are less popular. The -results below show us that clusters 0 through 3 are popular, while clusters 4 -and 5 are not very popular at all. +Now that we have figured out our clusters, let's do a little more +analysis to provide more insight into the clusters. With the information +below, we can see which clusters are more popular for businesses and +which are less popular. The results below show us that clusters 0 +through 3 are popular, while clusters 4 and 5 are not very popular at +all. -#+BEGIN_SRC python +```python # Show how many venues are in each cluster color_names = ['Dark Green', 'Red', 'Blue', 'Purple', 'Pink', 'Black'] for x in range(0,6): print("Color of Cluster", x, ":", color_names[x]) print("Venues found in Cluster", x, ":", nearby_venues.loc[nearby_venues['Cluster Labels'] == x, nearby_venues.columns[:]].shape[0]) print("---") -#+END_SRC +``` -#+CAPTION: Venues per Cluster -[[https://img.cleberg.net/blog/20200726-ibm-data-science/05_venues_per_cluster-min.png]] + -Our last piece of analysis is to summarize the categories of businesses within -each cluster. With these results, we can clearly see that restaurants, coffee -shops, and grocery stores are the most popular. +Our last piece of analysis is to summarize the categories of businesses +within each cluster. With these results, we can clearly see that +restaurants, coffee shops, and grocery stores are the most popular. -#+BEGIN_SRC python +```python # Calculate how many venues there are in each category # Sort from largest to smallest temp_df = nearby_venues.drop(columns=['name', 'lat', 'lng']) @@ -352,27 +361,29 @@ with pd.option_context('display.max_rows', None, 'display.max_columns', None): print("\n\n", "Cluster 3:", "\n", cluster3_grouped.loc[cluster3_grouped['Cluster Labels'] > 1]) print("\n\n", "Cluster 4:", "\n", cluster4_grouped.loc[cluster4_grouped['Cluster Labels'] > 1]) print("\n\n", "Cluster 5:", "\n", cluster5_grouped.loc[cluster5_grouped['Cluster Labels'] > 1]) -#+END_SRC +``` -#+CAPTION: Venues per Cluster, pt. 1 -[[https://img.cleberg.net/blog/20200726-ibm-data-science/06_categories_per_cluster_pt1-min.png]] + -#+CAPTION: Venues per Cluster, pt. 2 -[[https://img.cleberg.net/blog/20200726-ibm-data-science/07_categories_per_cluster_pt2-min.png]] + -* Discussion +# Discussion -In this project, we gathered location data for Lincoln, Nebraska, USA and -clustered the data using the k-means algorithm in order to identify the unique -clusters of businesses in Lincoln. Through these actions, we found that there -are six unique business clusters in Lincoln and that two of the clusters are -likely unsuitable for investors. The remaining four clusters have a variety of -businesses, but are largely dominated by restaurants and grocery stores. +In this project, we gathered location data for Lincoln, Nebraska, USA +and clustered the data using the k-means algorithm in order to identify +the unique clusters of businesses in Lincoln. Through these actions, we +found that there are six unique business clusters in Lincoln and that +two of the clusters are likely unsuitable for investors. The remaining +four clusters have a variety of businesses, but are largely dominated by +restaurants and grocery stores. -Using this project, investors can now make more informed decisions when deciding -the location and category of business in which to invest. +Using this project, investors can now make more informed decisions when +deciding the location and category of business in which to invest. -Further studies may involve other attributes for business locations, such as -population density, average wealth across the city, or crime rates. In addition, -further studies may include additional location data and businesses by utilizing -multiple sources, such as Google Maps and OpenStreetMap. +Further studies may involve other attributes for business locations, +such as population density, average wealth across the city, or crime +rates. In addition, further studies may include additional location data +and businesses by utilizing multiple sources, such as Google Maps and +OpenStreetMap. diff --git a/content/blog/2020-08-22-redirect-github-pages.md b/content/blog/2020-08-22-redirect-github-pages.md new file mode 100644 index 0000000..d9628fa --- /dev/null +++ b/content/blog/2020-08-22-redirect-github-pages.md @@ -0,0 +1,136 @@ ++++ +date = 2020-08-22 +title = "Redirect GitHub Pages from Subdomain to the Top-Level Domain" +description = "Learn how to redirect Github pages to the TLD." ++++ + +# Short answer + +## Step 1 + +Add a new file CNAME to your GitHub Pages repository containing only one +line: your top-level domain name. E.g.: `example.com` + +## Step 2 + +[Optional] but highly recommended + +2.1: Remove all other top-level records (prefixed with @) of type A from +your DNS configuration. + +2.2: Remove a CNAME record for the second-level domain www if it is +present. + +## Step 3 + +Add these 5 entries to the very top of your DNS configuration: + +```txt +@ A 185.199.108.153 +@ A 185.199.109.153 +@ A 185.199.110.153 +@ A 185.199.111.153 +www CNAME your_github_username.github.io. +``` + +Replace `your_github_username` with your actual GitHub +username. + +## Step 4 + +Wait for your DNS changes to propagate. DNS changes aren't effective +immediately. They can take up to a full day to propagate. + +# Long answer + +This issue has two sides. One is the DNS configuration itself. Another +one is the way GitHub Pages will forward HTTP requests. + +We need to know a few things to understand what GitHub is trying to say +in their documentation. + +## DNS Entry Types + +There are two types of DNS records which interest us: CNAME and A. + +`A` is also known as `Apex` or sometimes as +`root entry`. It forwards requests to a specified fixed IP +address. `CNAME` entry forwards requests to a specified URL +(actual valid plain text URL, not an IP address). + +## DNS Load balancing + +GitHub has one central URL address which accepts all DNS requests for +GitHub Pages: `http://username.github.io`. That URL is +resolved to different IP addresses based on your geographical location. +Website hosted on GitHub Pages is a simple collection of +`HTML`, `CSS` and `JS` files. GitHub +distributes these files to different servers across the globe. So that +when your browser sends a request from Europe, it receives data from a +server in Europe. The same is valid for the requests from Asia and the +USA. + +## What GitHub is trying to say + +Since `A` records in DNS must contain IP addresses, and they +must be either `185.199.108.153` or +`185.199.109.153` or `185.199.110.153` or +`185.199.111.153`, there is no way to forward requests to a +server located somewhere in Europe or Asia. Your website hosted at +GitHub Pages will be downloaded from a central GitHub Pages server. +There is a minor risk that if GitHub Pages DNS servers +(`x.x.x.153`) are down for some reason, all custom domains +which use fixed GitHub Pages IP addresses will not be accessible (their +DNS requests will not be resolvable). + +That is why GitHub strongly suggests to either use a second-level domain +for your GitHub Pages (e.g. `blog.example.com`) or use a DNS +service provider that supports a record type `ALIAS` that +acts as `A` record but forwards request to a URL address +(e.g. `username.github.io`) instead of a fixed IP address. + +## How GitHub Pages treats HTTP requests + +After a DNS request for `your_github_username.github.io` is +resolved into an IP address, e.g. `185.199.108.153` your +browser sends an HTTP request to that server with an HTTP header +`Host`. Below are `curl` examples that load the +same website (these examples might not work if you are behind a proxy +server): + +```sh +curl --header "Host: your_github_username.github.io" http://185.199.108.153/ +curl --header "Host: www.example.com" http://185.199.108.153/ +curl --header "Host: example.com" http://185.199.108.153/ +``` + +This way GitHub Pages servers know which user website to serve. + +> GitHub Pages server will automatically redirect HTTP requests to the +> top-level domain if your `CNAME` file contains +> `example.com` but `www.example.com` is +> requested. +> +> The same is valid if your `CNAME` file contains +> `www.example.com` but the header `Host` in the +> `HTTP` request contains `example.com`. + +## Why can't I add a `CNAME` record entry that accepts a top-level request (`@`) to my DNS configuration? + +Quote from the GitHub Pages documentation: + +> Warning: Do not create a CNAME record for your custom apex domain! +> Doing so may cause issues with other services, such as email, on that +> domain. + +# References: + +1. [Setting up a custom domain with GitHub + Pages](https://docs.github.com/en/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site) +2. [My custom domain isn't + working](https://docs.github.com/en/github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages) +3. [Cannot access my GitHub Pages website by IP + Address](https://serverfault.com/questions/589370/cannot-access-my-github-pages-website-by-ip-address) +4. [How do I set up GitHub Pages to redirect DNS requests from a + subdomain (e.g. www) to the top-level domain (TLD, Apex + record)?](https://stackoverflow.com/questions/23375422/how-do-i-set-up-github-pages-to-redirect-dns-requests-from-a-subdomain-e-g-www) diff --git a/blog/2020-08-29-php-auth-flow.org b/content/blog/2020-08-29-php-auth-flow.md index ff3e3d0..018a9cb 100644 --- a/blog/2020-08-29-php-auth-flow.org +++ b/content/blog/2020-08-29-php-auth-flow.md @@ -1,19 +1,23 @@ -#+date: 2020-08-29 -#+title: PHP Authentication Flow - -* Introduction - -When creating websites that will allow users to create accounts, the developer -always needs to consider the proper authentication flow for their app. For -example, some developers will utilize an API for authentication, some will use -OAuth, and some may just use their own simple database. - -For those using pre-built libraries, authentication may simply be a problem of -copying and pasting the code from their library's documentation. For example, -here's the code I use to authenticate users with the Tumblr OAuth API for my -Tumblr client, Vox Populi: - -#+BEGIN_SRC php ++++ +date = 2020-08-29 +title = "PHP Authentication Flow" +description = "Learn how to establish and maintain a basic user authentication flow in PHP." ++++ + +# Introduction + +When creating websites that will allow users to create accounts, the +developer always needs to consider the proper authentication flow for +their app. For example, some developers will utilize an API for +authentication, some will use OAuth, and some may just use their own +simple database. + +For those using pre-built libraries, authentication may simply be a +problem of copying and pasting the code from their library's +documentation. For example, here's the code I use to authenticate users +with the Tumblr OAuth API for my Tumblr client, Vox Populi: + +```php // Start the session session_start(); @@ -34,27 +38,28 @@ $client = new Tumblr\API\Client( $token, $token_secret ); -#+END_SRC +``` -However, developers creating authentication flows from scratch will need to -think carefully about when to make sure a web page will check the user's -authenticity. +However, developers creating authentication flows from scratch will need +to think carefully about when to make sure a web page will check the +user's authenticity. -In this article, we're going to look at a simple authentication flow using a -MySQL database and PHP. +In this article, we're going to look at a simple authentication flow +using a MySQL database and PHP. -* Creating User Accounts +# Creating User Accounts -The beginning to any type of user authentication is to create a user account. -This process can take many formats, but the simplest is to accept user input -from a form (e.g., username and password) and send it over to your database. -For example, here's a snippet that shows how to get username and password -parameters that would come when a user submits a form to your PHP script. +The beginning to any type of user authentication is to create a user +account. This process can take many formats, but the simplest is to +accept user input from a form (e.g., username and password) and send it +over to your database. For example, here's a snippet that shows how to +get username and password parameters that would come when a user submits +a form to your PHP script. -*Note*: Ensure that your password column is large enough to hold the hashed -value (at least 60 characters or longer). +**Note**: Ensure that your password column is large enough to hold the +hashed value (at least 60 characters or longer). -#+BEGIN_SRC php +```php // Get the values from the URL $username = $_POST['username']; $raw_password = $_POST['password']; @@ -87,15 +92,15 @@ if ($conn->query($sql) === TRUE) { } $conn->close(); -#+END_SRC +``` -* Validate Returning Users +# Validate Returning Users -To be able to verify that a returning user has a valid username and password in -your database is as simple as having users fill out a form and comparing their -inputs to your database. +To be able to verify that a returning user has a valid username and +password in your database is as simple as having users fill out a form +and comparing their inputs to your database. -#+BEGIN_SRC php +```php // Query the database for username and password // ... @@ -106,41 +111,42 @@ if(password_verify($password_input, $hashed_password)) { // Else, Redirect them back to the login page. ... -#+END_SRC +``` -* Storing Authentication State +# Storing Authentication State -Once you've created the user's account, now you're ready to initialize the -user's session. *You will need to do this on every page you load while the user -is logged in.* To do so, simply enter the following code snippet: +Once you've created the user's account, now you're ready to +initialize the user's session. **You will need to do this on every page +you load while the user is logged in.** To do so, simply enter the +following code snippet: -#+BEGIN_SRC php +```php session_start(); -#+END_SRC +``` -Once you've initialized the session, the next step is to store the session in a -cookie so that you can access it later. +Once you've initialized the session, the next step is to store the +session in a cookie so that you can access it later. -#+BEGIN_SRC php +```php setcookie(session_name()); -#+END_SRC +``` -Now that the session name has been stored, you'll be able to check if there's an -active session whenever you load a page. +Now that the session name has been stored, you'll be able to check if +there's an active session whenever you load a page. -#+BEGIN_SRC php +```php if(isset(session_name())) { // The session is active } -#+END_SRC +``` -* Removing User Authentication +# Removing User Authentication -The next logical step is to give your users the option to log out once they are -done using your application. This can be tricky in PHP since a few of the -standard ways do not always work. +The next logical step is to give your users the option to log out once +they are done using your application. This can be tricky in PHP since a +few of the standard ways do not always work. -#+BEGIN_SRC php +```php // Initialize the session. // If you are using session_name("something"), don't forget it now! session_start(); @@ -172,14 +178,18 @@ session_write_close(); // Go back to sign-in page header('Location: https://example.com/logged-out/'); die(); -#+END_SRC +``` -* Wrapping Up +# Wrapping Up -Now you should be ready to begin your authentication programming with PHP. You -can create user accounts, create sessions for users across different pages of -your site, and then destroy the user data when they're ready to leave. +Now you should be ready to begin your authentication programming with +PHP. You can create user accounts, create sessions for users across +different pages of your site, and then destroy the user data when +they're ready to leave. -For more information on this subject, I recommend reading the [[https://www.php.net/][PHP -Documentation]]. Specifically, you may want to look at [[https://www.php.net/manual/en/features.http-auth.php][HTTP Authentication with -PHP]], [[https://www.php.net/manual/en/book.session.php][session handling]], and [[https://www.php.net/manual/en/function.hash.php][hash]]. +For more information on this subject, I recommend reading the [PHP +Documentation](https://www.php.net/). Specifically, you may want to look +at [HTTP Authentication with +PHP](https://www.php.net/manual/en/features.http-auth.php), [session +handling](https://www.php.net/manual/en/book.session.php), and +[hash](https://www.php.net/manual/en/function.hash.php). diff --git a/content/blog/2020-09-01-visual-recognition.md b/content/blog/2020-09-01-visual-recognition.md new file mode 100644 index 0000000..912aabf --- /dev/null +++ b/content/blog/2020-09-01-visual-recognition.md @@ -0,0 +1,204 @@ ++++ +date = 2020-09-01 +title = "IBM Watson Visual Recognition" +description = "Exploring and visualizing data with Python." ++++ + +# What is IBM Watson? + +If you've never heard of [Watson](https://www.ibm.com/watson), this +service is a suite of enterprise-ready AI services, applications, and +tooling provided by IBM. Watson contains quite a few useful tools for +data scientists and students, including the subject of this post today: +visual recognition. + +If you'd like to view the official documentation for the Visual +Recognition API, visit the [API +Docs](https://cloud.ibm.com/apidocs/visual-recognition/visual-recognition-v3?code=python). + +# Prerequisites + +To be able to use Watson Visual Recognition, you'll need the following: + +1. Create a free account on [IBM Watson + Studio](https://www.ibm.com/cloud/watson-studio). +2. Add the [Watson Visual + Recognition](https://www.ibm.com/cloud/watson-visual-recognition) + service to your IBM Watson account. +3. Get your API key and URL. To do this, first go to the [profile + dashboard](https://dataplatform.cloud.ibm.com/home2?context=cpdaas) + for your IBM account and click on the Watson Visual Recognition + service you created. This will be listed in the section titled + **Your services**. Then click the **Credentials** tab and open the + **Auto-generated credentials** dropdown. Copy your API key and URL + so that you can use them in the Python script later. +4. **[Optional]** While not required, you can also create the Jupyter + Notebook for this project right inside [Watson + Studio](https://www.ibm.com/cloud/watson-studio). Watson Studio will + save your notebooks inside an organized project and allow you to use + their other integrated products, such as storage containers, AI + models, documentation, external sharing, etc. + +# Calling the IBM Watson Visual Recognition API + +Okay, now let's get started. + +To begin, we need to install the proper Python package for IBM Watson. + +```sh +pip install --upgrade --user "ibm-watson>=4.5.0" +``` + +Next, we need to specify the API key, version, and URL given to us when +we created the Watson Visual Recognition service. + +```python +apikey = "<your-apikey>" +version = "2018-03-19" +url = "<your-url>" +``` + +Now, let's import the necessary libraries and authenticate our service. + +```python +import json +from ibm_watson import VisualRecognitionV3 +from ibm_cloud_sdk_core.authenticators import IAMAuthenticator + +authenticator = IAMAuthenticator(apikey) +visual_recognition = VisualRecognitionV3( + version=version, + authenticator=authenticator +) + +visual_recognition.set_service_url(url) +``` + +**[Optional]** If you'd like to tell the API not to use any data to +improve their products, set the following header. + +```python +visual_recognition.set_default_headers({'x-watson-learning-opt-out': "true"}) +``` + +Now we have our API all set and ready to go. For this example, I'm +going to include a `dict` of photos to load as we test out +the API. + +```python +data = [ + { + "title": "Grizzly Bear", + "url": "https://example.com/photos/image1.jpg" + }, + { + "title": "Nature Lake", + "url": "https://example.com/photos/image2.jpg" + }, + { + "title": "Welcome Sign", + "url": "https://example.com/photos/image3.jpg" + }, + { + "title": "Honey Badger", + "url": "https://example.com/photos/image4.jpg" + }, + { + "title": "Grand Canyon Lizard", + "url": "https://example.com/photos/image5.jpg" + }, + { + "title": "Castle", + "url": "https://example.com/photos/image6.jpg" + } +] +``` + +Now that we've set up our libraries and have the photos ready, let's +create a loop to call the API for each image. The code below shows a +loop that calls the URL of each image and sends it to the API, +requesting results with at least 60% confidence. The results are output +to the console with dotted lines separating each section. + +In the case of an API error, the codes and explanations are output to +the console. + +```python +from ibm_watson import ApiException + +for x in range(len(data)): +try: + url = data[x]["url"] + images_filename = data[x]["title"] + classes = visual_recognition.classify( + url=url, + images_filename=images_filename, + threshold='0.6', + owners=["IBM"]).get_result() + print("-----------------------------------------------") + print("Image Title: ", data[x]["title"], "\n") + print("Image URL: ", data[x]["url"], "\n") + classification_results = classes["images"][0]["classifiers"][0]["classes"] + for result in classification_results: + print(result["class"], "(", result["score"], ")") + print("-----------------------------------------------") +except ApiException as ex: + print("Method failed with status code " + str(ex.code) + ": " + ex.message) +``` + +# The Results + +Here we can see the full result set of our function above. If you view +each of the URLs that we sent to the API, you'll be able to see that it +was remarkably accurate. To be fair, these are clear high-resolution, +clear photos shot with a professional camera. In reality, you will most +likely be processing images that are lower quality and may have a lot of +noise in the photo. + +However, we can clearly see the benefit of being able to call this API +instead of attempting to write our own image recognition function. Each +of the classifications returned was a fair description of the image. + +If you wanted to restrict the results to those that are at least 90% +confident or greater, you would simply adjust the `threshold` +in the `visual_recognition.classify()` function. + +When your program runs, it should show the output below for each photo +you provide. + +```txt +---------------------------------------------------------------- +Image Title: Grizzly Bear +Image URL: https://example.com/photos/image1.jpg + +brown bear ( 0.944 ) +bear ( 1 ) +carnivore ( 1 ) +mammal ( 1 ) +animal ( 1 ) +Alaskan brown bear ( 0.759 ) +greenishness color ( 0.975 ) +---------------------------------------------------------------- +``` + +# Discussion + +Now, this was a very minimal implementation of the API. We simply +supplied some images and looked to see how accurate the results were. +However, you could implement this type of API into many machine learning +(ML) models. + +For example, you could be working for a company that scans their +warehouses or inventory using drones. Would you want to pay employees to +sit there and watch drone footage all day in order to identify or count +things in the video? Probably not. Instead, you could use a +classification system similar to this one in order to train your machine +learning model to correctly identify items that the drones show through +video. More specifically, you could have your machine learning model +watch a drone fly over a field of sheep in order to count how many sheep +are living in that field. + +There are many ways to implement machine learning functionality, but +hopefully this post helped inspire some deeper thought about the tools +that can help propel us further into the future of machine learning and +AI. diff --git a/content/blog/2020-09-22-internal-audit.md b/content/blog/2020-09-22-internal-audit.md new file mode 100644 index 0000000..e761241 --- /dev/null +++ b/content/blog/2020-09-22-internal-audit.md @@ -0,0 +1,263 @@ ++++ +date = 2020-09-22 +title = "What is Internal Audit?" +description = "Learn about the Internal Audit function and their purpose." ++++ + + + +# Definitions + +One of the many reasons that Internal Audit needs such thorough +explaining to non-auditors is that Internal Audit can serve many +purposes, depending on the organization's size and needs. However, the +Institute of Internal Auditors (IIA) defines Internal Auditing as: + +> Internal auditing is an independent, objective assurance and +> consulting activity designed to add value and improve an +> organization's operations. It helps an organization accomplish its +> objectives by bringing a systematic, disciplined approach to evaluate +> and improve the effectiveness of risk management, control, and +> governance processes. + +However, this definition uses quite a few terms that aren't clear +unless the reader already has a solid understanding of the auditing +profession. To further explain, the following is a list of definitions +that can help supplement understanding of internal auditing. + +## Independent + +Independence is the freedom from conditions that threaten the ability of +the internal audit activity to carry out internal audit responsibilities +in an unbiased manner. To achieve the degree of independence necessary +to effectively carry out the responsibilities of the internal audit +activity, the chief audit executive has direct and unrestricted access +to senior management and the board. This can be achieved through a +dual-reporting relationship. Threats to independence must be managed at +the individual auditor, engagement, functional, and organizational +levels. + +## Objective + +Objectivity is an unbiased mental attitude that allows internal auditors +to perform engagements in such a manner that they believe in their work +product and that no quality compromises are made. Objectivity requires +that internal auditors do not subordinate their judgment on audit +matters to others. Threats to objectivity must be managed at the +individual auditor, engagement, functional, and organizational levels. + +## Assurance + +Assurance services involve the internal auditor's objective assessment +of evidence to provide opinions or conclusions regarding an entity, +operation, function, process, system, or other subject matters. The +internal auditor determines the nature and scope of an assurance +engagement. Generally, three parties are participants in assurance +services: (1) the person or group directly involved with the entity, +operation, function, process, system, or other subject - (the process +owner), (2) the person or group making the assessment - (the internal +auditor), and (3) the person or group using the assessment - (the user). + +## Consulting + +Consulting services are advisory in nature and are generally performed +at the specific request of an engagement client. The nature and scope of +the consulting engagement are subject to agreement with the engagement +client. Consulting services generally involve two parties: (1) the +person or group offering the advice (the internal auditor), and (2) the +person or group seeking and receiving the advice (the engagement +client). When performing consulting services, the internal auditor +should maintain objectivity and not assume management responsibility. + +## Governance, Risk Management, & Compliance (GRC) + +The integrated collection of capabilities that enable an organization to +reliably achieve objectives, address uncertainty and act with integrity. + +# Audit Charter & Standards + +First, it's important to note that not every organization needs +internal auditors. In fact, it's unwise for an organization to hire +internal auditors unless they have regulatory requirements for auditing +and have the capital to support the department. Internal audit is a cost +center that can only affect revenue indirectly. + +Once an organization determines the need for internal assurance +services, they will hire a Chief Audit Executive and create the audit +charter. This charter is a document, approved by the company's +governing body, that will define internal audit's purpose, authority, +responsibility, and position within the organization. Fortunately, the +IIA has model charters available to IIA members for those developing or +improving their charter. + +Beyond the charter and organizational documents, internal auditors +follow a few different standards in order to perform their job. First is +the International Professional Practices Framework (IPPF) by the IIA, +which is the model of standards for internal auditing. In addition, +ISACA's Information Technology Assurance Framework (ITAF) helps guide +auditors in reference to information technology (IT) compliance and +assurance. Finally, additional standards such as FASB, GAAP, and +industry-specific standards are used when performing internal audit +work. + +# Three Lines of Defense + +[The IIA](https://theiia.org) released the original Three Lines of +Defense model in 2013, but have released an updated version in 2020. +Here is what the Three Lines of Defense model has historically looked +like: + + + +I won't go into depth about the changes made to the model in this +article. Instead, let's take a look at the most current model. + + + +The updated model forgets the strict idea of areas performing their own +functions or line of defense. Instead of talking about management, risk, +and internal audit as 1-2-3, the new model creates a more fluid and +cooperative model. + +Looking at this model from an auditing perspective shows us that +auditors will need to align, communicate, and collaborate with +management, including business area managers and chief officers, as well +as reporting to the governing body. The governing body will instruct +internal audit *functionally* on their goals and track their progress +periodically. + +However, the internal audit department will report *administratively* to +a chief officer in the company for the purposes of collaboration, +direction, and assistance with the business. Note that in most +situations, the governing body is the audit committee on the company's +board of directors. + +The result of this structure is that internal audit is an independent +and objective function that can provide assurance over the topics they +audit. + +# Audit Process + +A normal audit will generally follow the same process, regardless of the +topic. However, certain special projects or abnormal business areas may +call for changes to the audit process. The audit process is not set in +stone, it's simply a set of best practices so that audits can be +performed consistently. + + + +While different organizations may tweak the process, it will generally +follow this flow: + +## 1. Risk Assessment + +The risk assessment part of the process has historically been performed +annually, but many organizations have moved to performing this process +much more frequently. In fact, some organizations are moving to an agile +approach that can take new risks into the risk assessment and +re-prioritize risk areas on-the-go. To perform a risk assessment, +leaders in internal audit will research industry risks, consult with +business leaders around the company, and perform analyses on company +data. + +Once a risk assessment has been documented, the audit department has a +prioritized list of risks that can be audited. This is usually in the +form of auditable entities, such as business areas or departments. + +## 2. Planning + +During the planning phase of an audit, auditors will meet with the +business area to discuss the various processes, controls, and risks +applicable to the business. This helps the auditors determine the scope +limits for the audit, as well as timing and subject-matter experts. +Certain documents will be created in this phase that will be used to +keep the audit on-track an in-scope as it goes forward. + +## 3. Testing + +The testing phase, also known as fieldwork or execution, is where +internal auditors will take the information they've discovered and test +it against regulations, industry standards, company rules, best +practices, as well as validating that any processes are complete and +accurate. For example, an audit of HR would most likely examine +processes such as employee on-boarding, employee termination, security +of personally identifiable information (PII), or the IT systems involved +in these processes. Company standards would be examined and compared +against how the processes are actually being performed day-to-day, as +well as compared against regulations such as the Equal Employment +Opportunity (EEO), American with Disabilities Act, and National Labor +Relations Act. + +## 4. Reporting + +Once all the tests have been completed, the audit will enter the +reporting phase. This is when the audit team will conclude on the +evidence they've collected, interviews they've held, and any opinions +they've formed on the controls in place. A summary of the audit +findings, conclusions, and specific recommendations are officially +communicated to the client through a draft report. Clients have the +opportunity to respond to the report and submit an action plan and time +frame. These responses become part of the final report which is +distributed to the appropriate level of administration. + +## 5. Follow-Up + +After audits have been completed and management has formed action plans +and time frames for audit issues, internal audit will follow up once +that due date has arrived. In most cases, the follow-up will simply +consist of a meeting to discuss how the action plan has been completed +and to request documentation to prove it. + +# Audit Department Structure + +While an internal audit department is most often thought of as a team of +full-time employees, there are actually many different ways in which a +department can be structured. As the world becomes more digital and +fast-paced, outsourcing has become a more attractive option for some +organizations. Internal audit can be fully outsourced or partially +outsourced, allowing for flexibility in cases where turnover is high. + +In addition, departments can implement a rotational model. This allows +for interested employees around the organization to rotate into the +internal audit department for a period of time, allowing them to obtain +knowledge of risks and controls and allowing the internal audit team to +obtain more business area knowledge. This program is popular in very +large organizations, but organizations tend to rotate lower-level audit +staff instead of managers. This helps prevent any significant knowledge +loss as auditors rotate out to business areas. + +# Consulting + +Consulting is not an easy task at any organization, especially for a +department that can have negative perceptions within the organization as +the "compliance police." However, once an internal audit department +has delivered value to organization, adding consulting to their suite of +services is a smart move. In most cases, Internal Audit can insert +themselves into a consulting role without affecting the process of +project management at the company. This means that internal audit can +add objective assurance and opinions to business areas as they develop +new processes, instead of coming in periodically to audit an area and +file issues that could have been fixed at the beginning. + +# Data Science & Data Analytics + + + +One major piece of the internal audit function in the modern world is +data science. While the process is data science, most auditors will +refer to anything in this realm as data analytics. Hot topics such as +robotic process automation (RPA), machine learning (ML), and data mining +have taken over the auditing world in recent years. These technologies +have been immensely helpful with increasing the effectiveness and +efficiency of auditors. + +For example, mundane and repetitive tasks can be automated in order for +auditors to make more room in their schedules for labor-intensive work. +Further, auditors will need to adapt technologies like machine learning +in order to extract more value from the data they're using to form +conclusions. diff --git a/blog/2020-09-25-happiness-map.org b/content/blog/2020-09-25-happiness-map.md index 287e1da..c55552c 100644 --- a/blog/2020-09-25-happiness-map.org +++ b/content/blog/2020-09-25-happiness-map.md @@ -1,88 +1,94 @@ -#+date: 2020-09-25 -#+title: Data Visualization: World Choropleth Map of Happiness ++++ +date = 2020-09-25 +title = "Data Visualization: World Choropleth Map of Happiness" +description = "Exploring and visualizing data with Python." ++++ -* Background Information +# Background Information -The dataset (obtained from [[https://www.kaggle.com/unsdsn/world-happiness][Kaggle]]) used in this article contains a list of -countries around the world, their happiness rankings and scores, as well as -other national scoring measures. +The dataset (obtained from +[Kaggle](https://www.kaggle.com/unsdsn/world-happiness)) used in this +article contains a list of countries around the world, their happiness +rankings and scores, as well as other national scoring measures. Fields include: -- Overall rank -- Country or region -- GDP per capita -- Social support -- Healthy life expectancy -- Freedom to make life choices -- Generosity -- Perceptions of corruption +- Overall rank +- Country or region +- GDP per capita +- Social support +- Healthy life expectancy +- Freedom to make life choices +- Generosity +- Perceptions of corruption -There are 156 records. Since there are ~195 countries in the world, we can see -that around 40 countries will be missing from this dataset. +There are 156 records. Since there are \~195 countries in the world, we +can see that around 40 countries will be missing from this dataset. -* Install Packages +# Install Packages -As always, run the =install= command for all packages needed to perform -analysis. +As always, run the `install` command for all packages needed +to perform analysis. -#+BEGIN_SRC python +```python !pip install folium geopandas matplotlib numpy pandas -#+END_SRC +``` -* Import the Data +# Import the Data -We only need a couple packages to create a choropleth map. We will use [[https://python-visualization.github.io/folium/][Folium]], -which provides map visualizations in Python. We will also use geopandas and -pandas to wrangle our data before we put it on a map. +We only need a couple packages to create a choropleth map. We will use +[Folium](https://python-visualization.github.io/folium/), which provides +map visualizations in Python. We will also use geopandas and pandas to +wrangle our data before we put it on a map. -#+BEGIN_SRC python +```python # Import the necessary Python packages import folium import geopandas as gpd import pandas as pd -#+END_SRC +``` -To get anything to show up on a map, we need a file that will specify the -boundaries of each country. Luckily, GeoJSON files exist (for free!) on the -internet. To get the boundaries of every country in the world, we will use the -GeoJSON link shown below. +To get anything to show up on a map, we need a file that will specify +the boundaries of each country. Luckily, GeoJSON files exist (for free!) +on the internet. To get the boundaries of every country in the world, we +will use the GeoJSON link shown below. -GeoPandas will take this data and load it into a dataframe so that we can easily -match it to the data we're trying to analyze. Let's look at the GeoJSON -dataframe: +GeoPandas will take this data and load it into a dataframe so that we +can easily match it to the data we're trying to analyze. Let's look at +the GeoJSON dataframe: -#+BEGIN_SRC python +```python # Load the GeoJSON data with geopandas geo_data = gpd.read_file('https://raw.githubusercontent.com/datasets/geo-countries/master/data/countries.geojson') geo_data.head() -#+END_SRC +``` -#+CAPTION: GeoJSON Dataframe -[[https://img.cleberg.net/blog/20200925-world-choropleth-map/geojson_df.png]] + -Next, let's load the data from the Kaggle dataset. I've downloaded this file, so -update the file path if you have it somewhere else. After loading, let's take a -look at this dataframe: +Next, let's load the data from the Kaggle dataset. I've downloaded +this file, so update the file path if you have it somewhere else. After +loading, let's take a look at this dataframe: -#+BEGIN_SRC python +```python # Load the world happiness data with pandas happy_data = pd.read_csv(r'~/Downloads/world_happiness_data_2019.csv') happy_data.head() -#+END_SRC +``` -#+CAPTION: Happiness Dataframe -[[https://img.cleberg.net/blog/20200925-world-choropleth-map/happiness_df.png]] + -* Clean the Data +# Clean the Data -Some countries need to be renamed, or they will be lost when you merge the -happiness and GeoJSON dataframes. This is something I discovered when the map -below showed empty countries. I searched both data frames for the missing -countries to see the naming differences. Any countries that do not have records -in the =happy_data= df will not show up on the map. +Some countries need to be renamed, or they will be lost when you merge +the happiness and GeoJSON dataframes. This is something I discovered +when the map below showed empty countries. I searched both data frames +for the missing countries to see the naming differences. Any countries +that do not have records in the `happy_data` df will not show +up on the map. -#+BEGIN_SRC python +```python # Rename some countries to match our GeoJSON data # Rename USA @@ -100,37 +106,38 @@ happy_data.at[republic_congo_index, 'Country or region'] = 'Republic of Congo' # Rename the DRC democratic_congo_index = happy_data.index[happy_data['Country or region'] == 'Congo (Kinshasa)'] happy_data.at[democratic_congo_index, 'Country or region'] = 'Democratic Republic of the Congo' -#+END_SRC +``` -* Merge the Data +# Merge the Data Now that we have clean data, we need to merge the GeoJSON data with the -happiness data. Since we've stored them both in dataframes, we just need to call -the =.merge()= function. +happiness data. Since we've stored them both in dataframes, we just +need to call the `.merge()` function. -We will also rename a couple columns, just so that they're a little easier to -use when we create the map. +We will also rename a couple columns, just so that they're a little +easier to use when we create the map. -#+BEGIN_SRC python +```python # Merge the two previous dataframes into a single geopandas dataframe merged_df = geo_data.merge(happy_data,left_on='ADMIN', right_on='Country or region') # Rename columns for ease of use merged_df = merged_df.rename(columns = {'ADMIN':'GeoJSON_Country'}) merged_df = merged_df.rename(columns = {'Country or region':'Country'}) -#+END_SRC +``` -#+CAPTION: Merged Dataframe -[[https://img.cleberg.net/blog/20200925-world-choropleth-map/merged_df.png]] + -* Create the Map +# Create the Map The data is finally ready to be added to a map. The code below shows the -simplest way to find the center of the map and create a Folium map object. The -important part is to remember to reference the merged dataframe for our GeoJSON -data and value data. The columns specify which geo data and value data to use. +simplest way to find the center of the map and create a Folium map +object. The important part is to remember to reference the merged +dataframe for our GeoJSON data and value data. The columns specify which +geo data and value data to use. -#+BEGIN_SRC python +```python # Assign centroids to map x_map = merged_df.centroid.x.mean() y_map = merged_df.centroid.y.mean() @@ -154,20 +161,21 @@ folium.Choropleth( smooth_factor=0, highlight=True ).add_to(world_map) -#+END_SRC +``` Let's look at the resulting map. -#+CAPTION: Choropleth Map -[[https://img.cleberg.net/blog/20200925-world-choropleth-map/map.png]] + -* Create a Tooltip on Hover +# Create a Tooltip on Hover -Now that we have a map set up, we could stop. However, I want to add a tooltip -so that I can see more information about each country. The =tooltip_data= code -below will show a popup on hover with all the data fields shown. +Now that we have a map set up, we could stop. However, I want to add a +tooltip so that I can see more information about each country. The +`tooltip_data` code below will show a popup on hover with all +the data fields shown. -#+BEGIN_SRC python +```python # Adding labels to map style_function = lambda x: {'fillColor': '#ffffff', 'color':'#000000', @@ -208,10 +216,10 @@ folium.LayerControl().add_to(world_map) # Display the map world_map -#+END_SRC +``` -The final image below will show you what the tooltip looks like whenever you -hover over a country. +The final image below will show you what the tooltip looks like whenever +you hover over a country. -#+CAPTION: Choropleth Map Tooltip -[[https://img.cleberg.net/blog/20200925-world-choropleth-map/tooltip_map.png]] + diff --git a/content/blog/2020-10-12-mediocrity.md b/content/blog/2020-10-12-mediocrity.md new file mode 100644 index 0000000..6aa0e48 --- /dev/null +++ b/content/blog/2020-10-12-mediocrity.md @@ -0,0 +1,120 @@ ++++ +date = 2020-10-12 +title = "On the Pursuit of Mediocrity" +description = "Musings on mediocrity." ++++ + +# Perfect is the Enemy of Good + +As the saying goes, "the best is the enemy of the good." As we strive +for perfection, we often fail to realize the implications of such an +undertaking. Attempting to reach perfection is often unrealistic. Even +worse, it can get in the way of achieving a good outcome. In certain +situations, we try so hard to achieve the ideal solution that we have +burned the bridges that would have allowed us to reach a lesser yet +still superb solution. + +Philosophers throughout history have inspected this plight from many +viewpoints. Greek mythology speaks of the [golden +mean](https://en.wikipedia.org/wiki/Golden_mean_(philosophy)), which +uses the story of Icarus to illustrate that sometimes "the middle +course" is the best solution. In this story, Daedalus, a famous artist +of his time, built feathered wings for himself and his son so that they +might escape the clutches of King Minos. Daedalus warns his beloved son +whom he loved so much to "fly the middle course", between the sea +spray and the sun's heat. Icarus did not heed his father; he flew up +and up until the sun melted the wax off his wings. For not heeding the +middle course, he fell into the sea and drowned. + +More recently, management scholars have explored the [Pareto +principle](https://en.wikipedia.org/wiki/Pareto_principle) and found +that as we increase the frequency of something, or strive to perform +actions to achieve some form of perfection, we run into [diminishing +returns](https://en.wikipedia.org/wiki/Diminishing_returns). + +Even further, Harold Demsetz is noted as coining the term [the Nirvana +fallacy](https://en.wikipedia.org/wiki/Nirvana_fallacy) in 1969, which +shows the fallacy of comparing actual things with unrealistic, idealized +alternatives. This is another trap that we may fall into, where we are +constantly thinking of the ultimate solutions to problems, when +something more realistic needs to be considered. + +Over and over throughout history, we've found that perfection is often +unrealistic and unachievable. However, we push ourselves and our peers +to "give 100%" or "go the extra mile," while it may be that the +better course is to give a valuable level of effort while considering +the effects of further effort on the outcome. Working harder does not +always help us achieve loftier goals. + +This has presented itself to me most recently during my time studying at +my university. I was anxious and feeling the stresses of my courses, +career, and personal life for quite a while, which was greatly affecting +how well I was doing at school and my level of effort at work. One day, +I happened to be talking to my father when he said something simple that +hit home: + +> All you can do is show up and do your best. Worrying about the +> outcomes won't affect the outcome itself. + +The thought was extremely straightforward and uncomplicated, yet it was +something that I had lost sight of during my stress-filled years at +school. Ever since then, I've found myself pausing and remembering that +quote every time I get anxious or stressed. It helps to stop and think +"Can I do anything to affect the outcome, or am I simply worrying over +something I can't change?" + +# When Mediocrity Isn't Enough + +One problem with the philosophies presented in this post is that they +are implemented far too often in situations where mediocrity simply +isn't adequate. For example, let's take a look at digital user data, +specifically personally-identifiable information (PII). As a +cybersecurity auditor in the United States, I have found that most +companies are concerned more with compliance than any actual safeguards +over the privacy or protection of user data. Other than companies who +have built their reputation on privacy and security, most companies will +use [satisficing](https://en.wikipedia.org/wiki/Satisficing) as their +primary decision-making strategy around user data. + +> Satisficing is a decision-making strategy or cognitive heuristic that +> entails searching through the available alternatives until an +> acceptability threshold is met. + +This means that each decision will be met with certain possible +solutions until one of the solutions meets their minimum acceptable +standards. For companies that deal with user data, the +minimum-acceptable standards come from three areas: + +1. Laws and regulations +2. Competitive pressure +3. Risk of monetary or reputation loss + +Working with project management or auditing, the primary concern here is +the risk of legal ramifications. Since the primary risk comes from laws +and regulations, companies will require that any project that involves +user data must follow all the rules of those laws so that the company +can protect itself from fines or other penalties. + +Following this, companies will consider best practices in order to place +itself in a competitive position (e.g. Google vs. Apple) and review any +recent or ongoing litigation against companies regarding user data. In a +perfect company, management would then consider the ethical +responsibilities of their organization and discuss their +responsibilities over things like personally-identifiable information. + +However, as we mentioned above, most companies follow the idea of +satisficing, which states that they have met the minimum acceptable +standards and can now move on to other decisions. Modern business +culture in the United States dictates that profits are the golden +measure of how well a company or manager is performing, so we often +don't think about our responsibilities beyond these basic standards. + +Not all situations demand excellence, but I believe that applying any +philosophy as a broad stroke across one's life can be a mistake. We +must be able to think critically about what we are doing as we do it and +ask ourselves a few questions. Have I done everything I can in this +situation? Is mediocrity an acceptable outcome, or should we strive for +perfection, even if we can't attain it? + +Taking a few moments to think critically throughout our day, as we make +decisions, can have a tremendous effect on the outcomes we create. diff --git a/content/blog/2020-12-27-website-redesign.md b/content/blog/2020-12-27-website-redesign.md new file mode 100644 index 0000000..997c961 --- /dev/null +++ b/content/blog/2020-12-27-website-redesign.md @@ -0,0 +1,102 @@ ++++ +date = 2020-12-27 +title = "Redesigning My Website: The 5 KB Result" +description = "A retrospective on my recent website redesign." ++++ + +# A Brief History + +As a form of continuous learning and entertainment, I've been running a +handful of websites since 2016 when I took my first programming courses +in college. I maintain one main website, the place I consider the +official website to represent me. Under this site, I have a handful of +subdirectories and subdomains. + +One of the parts I've enjoyed the most about web development is the +aspect of designing an identity for a web page and working to find +exciting ways to display the site's content. Inevitably, this means +I've changed the designs for my websites more times than I could +possibly count. Since I don't really host anything on my main webpage +that's vital, it allows me the freedom to change things as inspiration +strikes. + +Historically, I've relied on core utilities for spacing, components, +and layouts from [Bootstrap](https://getbootstrap.com) and added custom +CSS for fonts, accents, colors, and other items. I also tend to create +sites with no border radius on items, visible borders, and content that +takes up the entire screen (using whitespace inside components instead +of whitespace around my components). + +# The Redesign Process + +About a week ago, I found myself wishing for a new design yet again. The +prior design was largely inspired by IBM's [Carbon Design +System](https://www.carbondesignsystem.com) and relied on jQuery, +Bootstrap, along with some compressed +[.webp](https://en.wikipedia.org/wiki/WebP) images. + +To anyone who knows my preferences toward web design - and even in my +personal life - it should be no surprise that I immediately started +looking for inspiration on minimalism. While there are some decent +minimalistic designs on sites like +[Dribbble](https://dribbble.com/search/shots/popular/web-design?q=minimalism), +people seem to mostly discuss [brutalist web +design](https://brutalist-web.design) when you ask about minimalism. +While brutalist web design doesn't have to be minimal, it often is. + +I suppose, in a way, I did create a brutalist website since my HTML is +semantic and accessible, hyperlinks are colored and underlined, and all +native browser functions like scrolling and the back button work as +expected. However, I didn't think about brutalism while designing these +sites. + +The new design followed a simple design process. I walked through the +screens on my blog and asked myself: "Is this element necessary for a +user?" This allowed me to first start by removing all javascript, which +had the sole purpose of allowing users to open a collapsed navbar on +mobile. Replacing the collapsible navbar allowed me to remove both +jQuery and Bootstrap's javascript. + +Next, I removed things like author names (since I'm literally the only +person who will ever write on this site), multiple ways to click on a +blog post card, blog post descriptions, and the scroll-to-top button. It +also helped to move all categories to a single page, rather than have +each category on its own page. + +The final big piece to finish the +"[KonMari](https://en.wikipedia.org/wiki/Marie_Kondo#KonMari_method)"-like +part of my process was to remove Bootstrap CSS in its entirety. However, +this meant pulling out a few very useful classes, such as `.img-fluid` +and the default font stacks to keep in my custom CSS. + +After removing all the unnecessary pieces, I was finally able to +reorganize my content and add a very small amount of custom CSS to make +everything pretty. This took a brief amount of time, effectively just +consisting of me converting `<div>` tags into things like +`<ul>` lists and choosing accent colors. + +# The Results + +## Reflection + +So, what did all of this reorganizing do to my webpages? Well, first, my +websites are now **ridiculously fast**. Since the prior designs were +also minimal and didn't have many images, they measured up in +Firefox's Network Monitor around 300 KB - 600KB. After making the +changes, my main site is at 5 KB transferred (22 KB total), and my blog +is at 6.5 KB transferred (13 KB total). **That means the redesigned +pages are less than 2% the size of the old designs.** + +Google Lighthouse ranks the new webpage as 100 in performance, +accessibility, and best practices, with SEO at 92 since they think tap +targets are not sized appropriately for mobile users. First contextual +paints of the pages are under 0.8 seconds with 0 ms of blocking time. +However, the blog subdomain ranks at 100 for all four categories! First +contextual paints of the blog homepage are under 1.0 seconds with 0 ms +of blocking time, due to the fact that the CSS for my blog is within a +separate CSS file, and the CSS for my main website is simply embedded in +the HTML file. + +Now that everything is complete, I can confidently say I'm happy with +the result and proud to look at the fastest set of websites I've +created so far. diff --git a/content/blog/2020-12-28-neon-drive.md b/content/blog/2020-12-28-neon-drive.md new file mode 100644 index 0000000..d0cf329 --- /dev/null +++ b/content/blog/2020-12-28-neon-drive.md @@ -0,0 +1,94 @@ ++++ +date = 2020-12-28 +title = "Neon Drive: A Nostalgic 80s Arcade Racing Game" +description = "A video game review for Neon Drive." ++++ + +# Game Description + +[Neon Drive](https://store.steampowered.com/app/433910/Neon_Drive/) +presents itself as a simple arcade-style game inspired by the arcade +race games of the 1980s, yet it has managed to take up hours of my life +without much effort. The game description, directly from the Steam page, +is intriguing enough to entice anyone who's been looking for a good +arcade racing game: + +> Neon Drive is a slick retro-futuristic arcade game that will make your +> brain melt. You've been warned. From beautiful cityscapes and ocean +> roads to exploding enemy spaceships, Neon Drive has it all. + +# Gameplay + +The game holds true to the +[retro-futurism](https://en.wikipedia.org/wiki/Retrofuturism) style, +including chrome female robots, pixelated arcade machines, and +[outrun](https://teddit.net/r/outrun/) aesthetics. + +Each level of the game is shown as a separate arcade machine. Each +arcade machine lets you play on Normal, Hard, Insane, Practice, and Free +Run. To beat each arcade, you must reach the end of the level without +crashing your car into the various obstacles on the course. Basic levels +let you move left or right to avoid blocks in the road. Later levels put +you through other tests, such as dodging traffic or blasting asteroids. + +The game uses synthwave music to keep you on track to make the correct +moves by timing the beats of the songs to the correct moves on the +screen. It reminds me of the early Guitar Hero games, as well as mobile +apps like VOEZ - repetition and staying on-beat is the only way to win. + +# In-Game Screenshots + +Taking a look at the main menu, you can see that Neon Drive plays into +every stereotype you can think of around retro-futuristic, synthwave +arcades (in a good way). + + + +Once you get into the first level, we see that the choice of car fits +right in with the stereotypical cars of the 80s, like the +[DeLorean](https://en.wikipedia.org/wiki/DMC_DeLorean) or the [Ferrari +F40](https://en.wikipedia.org/wiki/Ferrari_F40). Each new level comes +with new color schemes and cars, so you should never get tired of the +aesthetic. + + + +Personally, I love the orange and blue colors used in level 2: + + + +If you're the competitive type and getting 100% on all arcade machines +isn't enough, there are leaderboards for the regular part of the game, +and the endurance game mode. + + + +# Other Suggestions + +Neon Drive sits nicely within the well-founded cult genre of Outrun. +Other games that I've enjoyed in this same spectrum are: + +- [Far Cry 3: Blood + Dragon](https://store.steampowered.com/app/233270/Far_Cry_3__Blood_Dragon/) +- [Retrowave](https://store.steampowered.com/app/1239690/Retrowave/) +- [Slipstream](https://store.steampowered.com/app/732810/Slipstream/) + +Although these games aren't necessarily in the same genre, they do have +aspects that place them close enough to interest gamers that enjoyed +Neon Drive: + +- [Black Ice](https://store.steampowered.com/app/311800/Black_Ice/) +- [Cloudpunk](https://store.steampowered.com/app/746850/Cloudpunk/) +- [Need for Speed: + Heat](https://store.steampowered.com/app/1222680/Need_for_Speed_Heat/) +- [VirtuaVerse](https://store.steampowered.com/app/1019310/VirtuaVerse/) + +Of course, if all you really care about is the arcade aspect of these +games, you can check out the [Atari +Vault](https://store.steampowered.com/app/400020/Atari_Vault/) or any of +the other classic games sold on Steam by companies like Namco, Atari. +For something like Nintendo, you'd have to settle for buying used +classic consoles or delve into the world of emulation. diff --git a/content/blog/2020-12-29-zork.md b/content/blog/2020-12-29-zork.md new file mode 100644 index 0000000..717def8 --- /dev/null +++ b/content/blog/2020-12-29-zork.md @@ -0,0 +1,95 @@ ++++ +date = 2020-12-29 +title = "Zork: Let's Explore a Classic" +description = "A video game review for Zork." ++++ + +# Download (Free) + +Before we get into the game itself, you should know that you can +download Zork for free from Infocom's [download +page](http://infocom-if.org/downloads/downloads.html). So feel free to +boot it up and take a ride back to the 1980s with this masterpiece. + +# Game Description + +Zork is an interactive, text-based computer game originally released in +1980. This series, split into three separate games, introduced a robust +and sophisticated text parser to gamers. People were largely used to the +simple commands used in the popular game [Colossal Cave +Adventure](https://en.wikipedia.org/wiki/Colossal_Cave_Adventure), but +Zork allowed users to send more complex commands that included +prepositions and conjunctions. + +Zork tracks your score as you explore the map, find tools, and collect +trophy items (e.g., a jewel-encrusted egg). When you place your trophy +items in the trophy case found in the Living Room area, you gain score +points. Collecting the Twenty Treasures of Zork and placing them within +the trophy case wins the game. However, you must explore the map, solve +puzzles, and avoid being eaten by a grue to collect these treasures. + +# The Map + +Since Zork is a vast and complex game, it helps to have a map as you +explore and collect your trophies. However, if you want to play the game +as it was truly intended, you should try to play it without using the +map. + + + +*[Map Source](https://www.filfre.net/2012/01/exploring-zork-part-1/)* + +# In-Game Screenshots + +After playing the game (for the first time ever) for several weeks +around 2014, I was finally able to beat the game with some online help +to find the last couple items. As I was writing this post, I installed +the game again to grab some screenshots to show off the true glory of +this game. As noted in [Jimmy Maher's +playthrough](https://www.filfre.net/2012/01/exploring-zork-part-1/), the +original Zork games looked quite a bit different due to the older +hardware of computers like the Apple II and multiple bug fixes that +Infocom pushed out after the game's initial release. My play-through +uses the [Zork +Anthology](https://store.steampowered.com/app/570580/Zork_Anthology/) +version, which utilizes DOSBox on Windows. + +The first screenshot here shows the introductory information, which +doesn't include instructions of any kind for the player. If you +haven't played text adventures before, try to use simple commands like +"go west," "look around," or "hit troll with elvish sword." + + + +In this second screenshot, we see the player has entered the house and +found the trophy case in the living room. The lantern and sword in this +room allow the player to explore dark areas and attack enemies. If you +don't use the lantern, you won't be able to see anything in dark +areas, and you may be eaten by a grue. + + + +Finally, we see that the player has found the first treasure: a +jewel-encrusted egg. These treasures can be taken back to the house and +placed in the trophy case or carried until you feel like you want to put +things away. + + + +# Conclusion + +It's been quite a few years since I first played Zork, but I clearly +remember the late nights and bloodshot eyes that helped me find all the +treasures. This game is well worth the time and effort, even though the +text-based aspect may be off-putting to gamers who didn't have to grow +up playing games without graphics. However, I believe that the strategy +and skills learned in early video games like Zork can actually help you, +even when playing newer games. + +If you do decide to play Zork, you can download Zork I, II, and III from +Infocom's [download +page](http://infocom-if.org/downloads/downloads.html) for free or search +the internet for an online version. diff --git a/blog/2021-01-01-seum.org b/content/blog/2021-01-01-seum.md index 639cede..0e0bb3a 100644 --- a/blog/2021-01-01-seum.org +++ b/content/blog/2021-01-01-seum.md @@ -1,32 +1,27 @@ -#+title: SEUM: Speedrunners from Hell -#+date: 2021-01-01 - -** Game Description -:PROPERTIES: -:CUSTOM_ID: game-description -:ID: 809DA4E6-4E0D-4179-B8FF-6C9E767EC74D -:END: -[[https://store.steampowered.com/app/457210/SEUM_Speedrunners_from_Hell/][SEUM: -Speedrunners from Hell]] is an incredibly fast-paced mashup of a puzzle -game and a free-running game. Created by [[https://pinestudio.co][Pine -Studio]] in early 2016 and first released as a -[[https://gamejolt.com/games/seum-speedrunners-from-hell-demo/154868][demo -on GameJolt]], this game was successfully green-lit on Steam and has -amassed a cult following on multiple consoles. ++++ +date = 2021-01-01 +title = "SEUM: Speedrunners from Hell" +description = "A video game review for SEUM: Speedrunners from Hell." ++++ + +## Game Description {#game-description id="809DA4E6-4E0D-4179-B8FF-6C9E767EC74D"} + +[SEUM: Speedrunners from +Hell](https://store.steampowered.com/app/457210/SEUM_Speedrunners_from_Hell/) +is an incredibly fast-paced mashup of a puzzle game and a free-running +game. Created by [Pine Studio](https://pinestudio.co) in early 2016 and +first released as a [demo on +GameJolt](https://gamejolt.com/games/seum-speedrunners-from-hell-demo/154868), +this game was successfully green-lit on Steam and has amassed a cult +following on multiple consoles. Here's the game description straight from the developers: -#+begin_quote -Like a bastard child of Quake 3 and Super Meat Boy, SEUM: Speedrunners -from Hell is truly hardcore and focuses on speed and fast reaction. +> Like a bastard child of Quake 3 and Super Meat Boy, SEUM: Speedrunners +> from Hell is truly hardcore and focuses on speed and fast reaction. -#+end_quote +## Story {#story id="BF401145-763D-4399-922B-7D73322B5B40"} -** Story -:PROPERTIES: -:CUSTOM_ID: story -:ID: BF401145-763D-4399-922B-7D73322B5B40 -:END: SEUM does a great job setting the stage when you open the game for the first time, playing an animated video in the form of comic book images. You see Marty, the protagonist, sitting around drinking his beer as @@ -38,14 +33,10 @@ use all the powers in the game. Check out the screenshot below for one of the first panels of the storyline: -#+caption: SEUM Story -[[https://img.cleberg.net/blog/20210101-seum/seum_story.png]] + + +## Gameplay {#gameplay id="A55CB1AF-E818-4CA7-BF69-E8141369C269"} -** Gameplay -:PROPERTIES: -:CUSTOM_ID: gameplay -:ID: A55CB1AF-E818-4CA7-BF69-E8141369C269 -:END: To accomplish each level, you will need to get to the final blue portal under a certain time limit. You can beat a level by getting to the portal before the time meter runs out or "Dominate" a level by beating @@ -58,50 +49,44 @@ to go through any existing orange portals, light all yellow beacons, avoid things like fireballs and blades, or use any satanic power orbs lying around. These special abilities include: -- Gravity -- Teleport -- Rewind -- Spawn platform -- Roar (DLC) -- Rocket (DLC) -- Shadow world (DLC) +- Gravity +- Teleport +- Rewind +- Spawn platform +- Roar (DLC) +- Rocket (DLC) +- Shadow world (DLC) For the main storyline, there are nine floors to beat. Each floor contains nine regular levels, one boss level, and one bonus level; -although you don't technically need to beat all levels to advance to the -next floor. +although you don't technically need to beat all levels to advance to +the next floor. + + -#+caption: SEUM Floor Menu -[[https://img.cleberg.net/blog/20210101-seum/seum_floor.png]] +## In-Game Screenshots {#in-game-screenshots id="C779F008-4C8A-4BA4-AA31-60A1BF5A3EE3"} -** In-Game Screenshots -:PROPERTIES: -:CUSTOM_ID: in-game-screenshots -:ID: C779F008-4C8A-4BA4-AA31-60A1BF5A3EE3 -:END: The main menu gives you plenty of options for tuning your system, playing main levels, playing the DLC, or exploring the other game modes. -#+caption: SEUM Main Menu -[[https://img.cleberg.net/blog/20210101-seum/seum_menu.png]] + Once you enter a level, you can look around and strategize before starting. Clicking any button will start the menu, and you'll have to restart if you die. One of the great things about SEUM is that it has -great keyboard shortcuts. You can quickly smash =R= to restart the level -or =M= to return to the level menu. +great keyboard shortcuts. You can quickly smash `R` to +restart the level or `M` to return to the level menu. -#+caption: SEUM Level -[[https://img.cleberg.net/blog/20210101-seum/seum_level.png]] + Once you're able to win a level, you'll see the high scores and can watch replays of the best scores. -#+caption: SEUM Win -[[https://img.cleberg.net/blog/20210101-seum/seum_win.png]] + Each regular level contains a beer in a disguised location that may take some out-of-the-box thinking. -#+caption: SEUM Beer -[[https://img.cleberg.net/blog/20210101-seum/seum_beer.png]] + diff --git a/blog/2021-01-04-fediverse.org b/content/blog/2021-01-04-fediverse.md index 4aa9d6f..f2cca30 100644 --- a/blog/2021-01-04-fediverse.org +++ b/content/blog/2021-01-04-fediverse.md @@ -1,10 +1,11 @@ -#+title: A Simple Guide to the Fediverse -#+date: 2021-01-04 ++++ +date = 2021-01-04 +title = "A Simple Guide to the Fediverse" +description = "Learn about the basics of the Fediverse." ++++ + +## What is the Fediverse? -** What is the Fediverse? -:PROPERTIES: -:CUSTOM_ID: what-is-the-fediverse -:END: The fediverse is a federated universe of servers commonly used for sharing content, like social media. So, instead of having to rely on a single organization to run the server (e.g. Facebook), the fediverse is @@ -21,8 +22,8 @@ and communicate back and forth without having to be on the same server. However, responsible email admins are there to set rules and control the traffic going in/out of the server. -#+caption: Federated services diagram -[[https://img.cleberg.net/blog/20210104-a-simple-guide-to-the-fediverse/federated-example.svg]] + The main objective of this architecture is to decentralize the control within the internet connections. For example, if you run your own @@ -35,12 +36,13 @@ This strategy is great for making sure control of the social web isn't controlled by a single organization, but it also has some downsides. If I create a Mastodon instance and get a ton of users to sign up, I can shut the server down at any time. That means you're at risk of losing -the content you've created unless you back it up, or the server backs it -up for you. Also, depending on the software used (e.g. Mastodon, +the content you've created unless you back it up, or the server backs +it up for you. Also, depending on the software used (e.g. Mastodon, Pixelfed, etc.), censorship may still be an issue if the server admins decide they want to censor their users. Now, censorship isn't always a -bad thing and can even benefit the community as a whole, but you'll want -to determine which servers align with your idea of proper censorship. +bad thing and can even benefit the community as a whole, but you'll +want to determine which servers align with your idea of proper +censorship. However, these are risks that we take when we sign up for any online platform. Whatever your reason is for trying out federated social @@ -50,74 +52,55 @@ with the increased difficulty understanding and signing up for these platforms. Perhaps increased regulation and litigation against current social media sites will push more users into the fediverse. -** Federated Alternatives to Popular Sites -:PROPERTIES: -:CUSTOM_ID: federated-alternatives-to-popular-sites -:END: +## Federated Alternatives to Popular Sites + The list below is a small guide that will show you federated alternatives to current popular websites. There are many more out there, so go and explore: you might just find the perfect home. -*** Reddit -:PROPERTIES: -:CUSTOM_ID: reddit -:END: -- [[https://lemmy.ml/instances][Lemmy]] - -*** Twitter/Facebook/Tumblr -:PROPERTIES: -:CUSTOM_ID: twitterfacebooktumblr -:END: -- [[https://joinmastodon.org][Mastodon]] -- [[https://diasporafoundation.org][Diaspora]] -- [[https://friendi.ca][Friendica]] -- [[https://gnusocial.network][GNU Social]] -- [[https://pleroma.social][Pleroma]] - -*** Instagram -:PROPERTIES: -:CUSTOM_ID: instagram -:END: -- [[https://pixelfed.org][Pixelfed]] - -*** Slack/Discord -:PROPERTIES: -:CUSTOM_ID: slackdiscord -:END: -- [[https://element.io][Matrix]] - -*** Youtube/Vimeo -:PROPERTIES: -:CUSTOM_ID: youtubevimeo -:END: -- [[https://joinpeertube.org][Peertube]] - -*** Spotify/Soundcloud -:PROPERTIES: -:CUSTOM_ID: spotifysoundcloud -:END: -- [[https://funkwhale.audio][Funkwhale]] - -*** Podcasting -:PROPERTIES: -:CUSTOM_ID: podcasting -:END: -- [[https://pubcast.pub][Pubcast]] - -*** Medium/Blogger -:PROPERTIES: -:CUSTOM_ID: mediumblogger -:END: -- [[https://writefreely.org][WriteFreely]] - -** Get Started -:PROPERTIES: -:CUSTOM_ID: get-started -:END: +### Reddit + +- [Lemmy](https://lemmy.ml/instances) + +### Twitter/Facebook/Tumblr + +- [Mastodon](https://joinmastodon.org) +- [Diaspora](https://diasporafoundation.org) +- [Friendica](https://friendi.ca) +- [GNU Social](https://gnusocial.network) +- [Pleroma](https://pleroma.social) + +### Instagram + +- [Pixelfed](https://pixelfed.org) + +### Slack/Discord + +- [Matrix](https://element.io) + +### Youtube/Vimeo + +- [Peertube](https://joinpeertube.org) + +### Spotify/Soundcloud + +- [Funkwhale](https://funkwhale.audio) + +### Podcasting + +- [Pubcast](https://pubcast.pub) + +### Medium/Blogger + +- [WriteFreely](https://writefreely.org) + +## Get Started + The best way to get started is to simply sign up and learn as you go. If you're comfortable signing up through a Mastodon, Pleroma, or Friendica -server, here is [[https://fediverse.party/en/portal/servers][a list of -themed servers]] to choose from. If you're looking for something else, -try a web search for a federated alternative to your favorite sites. +server, here is [a list of themed +servers](https://fediverse.party/en/portal/servers) to choose from. If +you're looking for something else, try a web search for a federated +alternative to your favorite sites. Find a server that focuses on your passions and start there! diff --git a/blog/2021-01-07-ufw.org b/content/blog/2021-01-07-ufw.md index 242e296..6534a75 100644 --- a/blog/2021-01-07-ufw.org +++ b/content/blog/2021-01-07-ufw.md @@ -1,10 +1,11 @@ -#+title: Secure Your Network with the Uncomplicated Firewall -#+date: 2021-01-07 ++++ +date = 2021-01-07 +title = "Secure Your Network with the Uncomplicated Firewall" +description = "A simple guide to the UFW." ++++ + +## Uncomplicated Firewall -** Uncomplicated Firewall -:PROPERTIES: -:CUSTOM_ID: uncomplicated-firewall -:END: Uncomplicated Firewall, also known as ufw, is a convenient and beginner-friendly way to enforce OS-level firewall rules. For those who are hosting servers or any device that is accessible to the world (i.e., @@ -14,160 +15,147 @@ implemented and active. Ufw is available by default in all Ubuntu installations after 8.04 LTS. For other distributions, you can look to install ufw or check if there are alternative firewalls installed already. There are usually -alternatives available, such as Fedora's =firewall= and the package -available on most distributions: =iptables=. Ufw is considered a -beginner-friendly front-end to iptables. +alternatives available, such as Fedora's `firewall` and the +package available on most distributions: `iptables`. Ufw is +considered a beginner-friendly front-end to iptables. -[[https://gufw.org][Gufw]] is available as a graphical user interface +[Gufw](https://gufw.org) is available as a graphical user interface (GUI) application for users who are uncomfortable setting up a firewall through a terminal. -[[https://img.cleberg.net/blog/20210107-secure-your-network-with-the-uncomplicated-firewall/gufw.png]] + + +## Getting Help -** Getting Help -:PROPERTIES: -:CUSTOM_ID: getting-help -:END: If you need help figuring out commands, remember that you can run the -=--help= flag to get a list of options. +`--help` flag to get a list of options. -#+begin_src sh +```sh sudo ufw --help -#+end_src +``` + +## Set Default State -** Set Default State -:PROPERTIES: -:CUSTOM_ID: set-default-state -:END: The proper way to run a firewall is to set a strict default state and slowly open up ports that you want to allow. This helps prevent anything malicious from slipping through the cracks. The following command prevents all incoming traffic (other than the rules we specify later), but you can also set this for outgoing connections, if necessary. -#+begin_src sh +```sh sudo ufw default deny incoming -#+end_src +``` You should also allow outgoing traffic if you want to allow the device to communicate back to you or other parties. For example, media servers like Plex need to be able to send out data related to streaming the media. -#+begin_src sh +```sh sudo ufw default allow outgoing -#+end_src +``` -** Adding Port Rules -:PROPERTIES: -:CUSTOM_ID: adding-port-rules -:END: -Now that we've disabled all incoming traffic by default, we need to open -up some ports (or else no traffic would be able to come in). If you need -to be able to =ssh= into the machine, you'll need to open up port 22. +## Adding Port Rules -#+begin_src sh +Now that we've disabled all incoming traffic by default, we need to +open up some ports (or else no traffic would be able to come in). If you +need to be able to `ssh` into the machine, you'll need to +open up port 22. + +```sh sudo ufw allow 22 -#+end_src +``` You can also issue more restrictive rules. The following rule will allow -=ssh= connections only from machines on the local subnet. +`ssh` connections only from machines on the local subnet. -#+begin_src sh +```sh sudo ufw allow proto tcp from 192.168.0.0/24 to any port 22 -#+end_src +``` If you need to set a rule that isn't tcp, just append your connection type to the end of the rule. -#+begin_src sh +```sh sudo ufw allow 1900/udp -#+end_src +``` + +## Enable ufw -** Enable ufw -:PROPERTIES: -:CUSTOM_ID: enable-ufw -:END: Now that the firewall is configured and ready to go, you can enable the firewall. -#+begin_src sh +```sh sudo ufw enable -#+end_src +``` A restart may be required for the firewall to begin operating. -#+begin_src sh +```sh sudo reboot now -#+end_src +``` + +## Checking Status -** Checking Status -:PROPERTIES: -:CUSTOM_ID: checking-status -:END: Now that the firewall is enabled, let's check and see what the rules look like. -#+begin_src sh +```sh sudo ufw status numbered -#+end_src +``` -#+begin_src txt +```txt Status: active To Action From -- ------ ---- [ 1] 22 ALLOW IN Anywhere [ 2] 22 (v6) ALLOW IN Anywhere (v6) -#+end_src +``` + +## Deleting Rules -** Deleting Rules -:PROPERTIES: -:CUSTOM_ID: deleting-rules -:END: If you need to delete a rule, you need to know the number associated with that rule. Let's delete the first rule in the table above. You'll be asked to confirm the deletion as part of this process. -#+begin_src sh +```sh sudo ufw delete 1 -#+end_src +``` + +## Managing App Rules -** Managing App Rules -:PROPERTIES: -:CUSTOM_ID: managing-app-rules -:END: Luckily, there's a convenient way for installed applications to create -files that ufw can easily implement so that you don't have to search and -find which ports your application requires. To see if your device has -any applications with pre-installed ufw rules, execute the following +files that ufw can easily implement so that you don't have to search +and find which ports your application requires. To see if your device +has any applications with pre-installed ufw rules, execute the following command: -#+begin_src sh +```sh sudo ufw app list -#+end_src +``` The results should look something like this: -#+begin_src txt +```txt Available applications: OpenSSH Samba plexmediaserver plexmediaserver-all plexmediaserver-dlna -#+end_src +``` If you want to get more information on a specific app rule, use the -=info= command. +`info` command. -#+begin_src sh +```sh sudo ufw app info plexmediaserver-dlna -#+end_src +``` You'll get a blurb of info back like this: -#+begin_src txt +```txt Profile: plexmediaserver-dlna Title: Plex Media Server (DLNA) Description: The Plex Media Server (additional DLNA capability only) @@ -175,31 +163,29 @@ Description: The Plex Media Server (additional DLNA capability only) Ports: 1900/udp 32469/tcp -#+end_src +``` You can add or delete app rules the same way that you'd add or delete specific port rules. -#+begin_src sh +```sh sudo ufw allow plexmediaserver-dlna -#+end_src +``` -#+begin_src sh +```sh sudo ufw delete RULE|NUM -#+end_src +``` + +## Creating App Rules -** Creating App Rules -:PROPERTIES: -:CUSTOM_ID: creating-app-rules -:END: If you'd like to create you own app rule, you'll need to create a file -in the =/etc/ufw/applications.d= directory. Within the file you create, -you need to make sure the content is properly formatted. +in the `/etc/ufw/applications.d` directory. Within the file +you create, you need to make sure the content is properly formatted. -For example, here are the contents my =plexmediaserver= file, which -creates three distinct app rules for ufw: +For example, here are the contents my `plexmediaserver` file, +which creates three distinct app rules for ufw: -#+begin_src config +```config [plexmediaserver] title=Plex Media Server (Standard) description=The Plex Media Server @@ -214,24 +200,24 @@ ports=1900/udp|32469/tcp title=Plex Media Server (Standard + DLNA) description=The Plex Media Server (with additional DLNA capability) ports=32400/tcp|3005/tcp|5353/udp|8324/tcp|32410:32414/udp|1900/udp|32469/tcp -#+end_src +``` -So, if I wanted to create a custom app rule called "mycustomrule," I'd -create a file and add my content like this: +So, if I wanted to create a custom app rule called "mycustomrule," +I'd create a file and add my content like this: -#+begin_src sh +```sh sudo nano /etc/ufw/applications.d/mycustomrule -#+end_src +``` -#+begin_src config +```config [mycustomrule] title=My Custom Rule description=This is a temporary ufw app rule. ports=88/tcp|9100/udp -#+end_src +``` Then, I would just enable this rule in ufw. -#+begin_src sh +```sh sudo ufw allow mycustomrule -#+end_src +``` diff --git a/blog/2021-02-19-macos.org b/content/blog/2021-02-19-macos.md index efbe257..e446fbf 100644 --- a/blog/2021-02-19-macos.org +++ b/content/blog/2021-02-19-macos.md @@ -1,10 +1,11 @@ -#+title: macOS: Testing Out A New OS -#+date: 2021-02-19 ++++ +date = 2021-02-19 +title = "macOS: Testing Out A New OS" +description = "A retrospective on my migration from Linux to macOS." ++++ + +## Diving into macOS -** Diving into macOS -:PROPERTIES: -:CUSTOM_ID: diving-into-macos -:END: After spending nearly 15 years working with Windows and 8 years on Linux, I have experienced macOS for the first time. By chance, my spouse happened to buy a new MacBook and gifted me their 2013 model. Of course, @@ -13,24 +14,22 @@ around for gaming needs, but over the past week I've found myself using the MacBook more and more for things that don't require gaming specs or advanced dev tools. -** Initial Thoughts -:PROPERTIES: -:CUSTOM_ID: initial-thoughts -:END: +## Initial Thoughts + Before I move on to the technical aspects of my set-up, I want to take some time and express my thoughts on the overall OS. -#+caption: macOS Desktop -[[https://img.cleberg.net/blog/20210219-macos-testing-out-a-new-os/macos-desktop.png]] + As expected, the initial computer setup is a breeze with Mac's guided GUI installer. The desktop itself reminds me of GNOME more than anything else I've -seen: even Pantheon from [[https://elementary.io/][ElementaryOS]], which +seen: even Pantheon from [ElementaryOS](https://elementary.io/), which people commonly refer to as the closest Linux distro to macOS. The desktop toolbar is great and far surpasses the utility of the GNOME -toolbar due to the fact that the extensions and icons /actually work/. I +toolbar due to the fact that the extensions and icons *actually work*. I launch macOS and immediately see my shortcuts for Tresorit, Bitwarden, and Mullvad pop up as the computer loads. @@ -52,10 +51,8 @@ The rest of this post explains the technicalities of how I set up my CLI environment to make me feel more at-home, similar to the environments I set up on Fedora, Ubuntu, etc. -** Making it Feel Like Home -:PROPERTIES: -:CUSTOM_ID: making-it-feel-like-home -:END: +## Making it Feel Like Home + If you're someone who uses Linux primarily, no doubt your first thought when booting macOS will be the same as mine was: "Where is the terminal and how do I set up my favorite utilities?" @@ -63,163 +60,155 @@ and how do I set up my favorite utilities?" Luckily, macOS hasn't completely hidden away the development tools from the average user. You can easily find the Terminal app in the Launchpad area, but it's probably not what you're used to. I was surprised (and -happy) to see that the default shell is =zsh=, the shell I use on all of -my Linux distros. However, the commands are not the same - even the ones -you may think are native to the shell. Commands like =dir= do not exist, -so other native commands like =ls -la= or =pwd= are more useful here. +happy) to see that the default shell is `zsh`, the shell I +use on all of my Linux distros. However, the commands are not the same - +even the ones you may think are native to the shell. Commands like +`dir` do not exist, so other native commands like +`ls -la` or `pwd` are more useful here. With only a few minutes of installing and tweaking a few packages, I was able to recreate a terminal environment that I feel very comfortable using. See the image below for a preview of the iTerm2 app with a split view between my macOS desktop shell and an SSH session into my server. -#+caption: iTerm2 -[[https://img.cleberg.net/blog/20210219-macos-testing-out-a-new-os/iterm2.png]] - -** Xcode -:PROPERTIES: -:CUSTOM_ID: xcode -:END: -My first step was to search the web for any hints on how to get =zsh= -back up to the state I like, with extensions, themes, etc. My first step -was to install the CLI tools for -[[https://developer.apple.com/xcode/][Xcode]], Apple's suite of + + +## Xcode + +My first step was to search the web for any hints on how to get +`zsh` back up to the state I like, with extensions, themes, +etc. My first step was to install the CLI tools for +[Xcode](https://developer.apple.com/xcode/), Apple's suite of development tools. -#+begin_src sh +```sh sudo xcode-select -r -#+end_src +``` -#+begin_src sh +```sh sudo xcode-select --install -#+end_src +``` -** Homebrew -:PROPERTIES: -:CUSTOM_ID: homebrew -:END: -Next up is to install [[https://brew.sh][Homebrew]], a nifty package +## Homebrew + +Next up is to install [Homebrew](https://brew.sh), a nifty package manager for macOS. -#+begin_src sh +```sh /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -#+end_src +``` I ran into a permission error when installing Homebrew: -#+begin_src sh +```sh Error: Failed to link all completions, docs and manpages: Permission denied @ rb_file_s_symlink - (../../../Homebrew/completions/zsh/_brew, /usr/local/share/zsh/site-functions/_brew) Failed during: /usr/local/bin/brew update --force --quiet -#+end_src +``` I found that the following permission modification worked like a charm. However, I noted that some users online discussed the fact that this solution may not work if your system has multiple users who use Homebrew. -#+begin_src sh +```sh sudo chown -R $(whoami) $(brew --prefix)/* -#+end_src +``` Next up is to ensure Homebrew is updated and cleaned. -#+begin_src sh +```sh brew update -#+end_src +``` -#+begin_src sh +```sh brew cleanup -#+end_src +``` + +## iTerm2 -** iTerm2 -:PROPERTIES: -:CUSTOM_ID: iterm2 -:END: Now that I've installed the basic utilities for development, I moved onto installing iTerm2, a much better terminal than the default. -#+begin_src sh +```sh brew install --cask iterm2 -#+end_src +``` -I also used the =Make iTerm2 Default Term= and -=Install Shell Integration= options in the iTerm2 application menu to -make sure I don't run into any issues later on with different terminals. +I also used the `Make iTerm2 Default Term` and +`Install Shell Integration` options in the iTerm2 application +menu to make sure I don't run into any issues later on with different +terminals. -We will also install =zsh= so we can use it in iTerm2. +We will also install `zsh` so we can use it in iTerm2. -#+begin_src sh +```sh brew install zsh -#+end_src +``` -** Oh-My-Zsh -:PROPERTIES: -:CUSTOM_ID: oh-my-zsh -:END: -I've shown the great aspects of [[https://ohmyz.sh][Oh My Zsh]] in other -blog posts, so I'll skip over that speech for now. Simply install it and -run an update. +## Oh-My-Zsh -#+begin_src sh +I've shown the great aspects of [Oh My Zsh](https://ohmyz.sh) in other +blog posts, so I'll skip over that speech for now. Simply install it +and run an update. + +```sh sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)" -#+end_src +``` -#+begin_src sh +```sh omz update -#+end_src +``` Finally, restart the iTerm2 application to ensure all changes go into effect. -** Oh-My-Zsh Themes -:PROPERTIES: -:CUSTOM_ID: oh-my-zsh-themes -:END: +## Oh-My-Zsh Themes + Let's change the theme of the terminal to make it a little more friendly. -#+begin_src sh +```sh open ~/.zshrc -#+end_src +``` The third section of this file should contain a line like the code -below. Change that theme to -[[https://github.com/ohmyzsh/ohmyzsh/wiki/Themes][any theme you want]], -save the file, and exit. +below. Change that theme to [any theme you +want](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes), save the file, +and exit. -#+begin_src sh +```sh ZSH_THEME="af-magic" -#+end_src - -After changing the =.zshrc= file, you'll need to close your terminal and -re-open it to see the changes. Optionally, just open a new tab if you're -using iTerm2, and you'll see the new shell config. - -** Oh-My-Zsh Plugins -:PROPERTIES: -:CUSTOM_ID: oh-my-zsh-plugins -:END: -Of course, my customization of =zsh= would not be complete without -[[https://github.com/zsh-users/zsh-autosuggestions][zsh-autosuggestions]]. -This will bring up commands you've run in the past as you type them. For -example, if you've run =ssh user@192.168.1.99= before, the terminal will -show this command as soon as you start typing it (e.g. =zsh u=), and you -can hit the right arrow to autocomplete the command. - -#+begin_src sh +``` + +After changing the `.zshrc` file, you'll need to close your +terminal and re-open it to see the changes. Optionally, just open a new +tab if you're using iTerm2, and you'll see the new shell config. + +## Oh-My-Zsh Plugins + +Of course, my customization of `zsh` would not be complete +without +[zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions). +This will bring up commands you've run in the past as you type them. +For example, if you've run `ssh user@192.168.1.99` before, +the terminal will show this command as soon as you start typing it +(e.g. =zsh u=), and you can hit the right arrow to autocomplete the +command. + +```sh git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions -#+end_src +``` -#+begin_src sh +```sh open ~/.zshrc -#+end_src +``` -#+begin_src sh +```sh # Scroll down the script and edit this line to add zsh-autosuggestions plugins=(git zsh-autosuggestions) -#+end_src +``` -Remember: After changing the =.zshrc= file, you'll need to close your -terminal and re-open it to see the changes. Optionally, just open a new -tab if you're using iTerm2, and you'll see the new shell config. +Remember: After changing the `.zshrc` file, you'll need to +close your terminal and re-open it to see the changes. Optionally, just +open a new tab if you're using iTerm2, and you'll see the new shell +config. diff --git a/blog/2021-03-19-clone-github-repos.org b/content/blog/2021-03-19-clone-github-repos.md index edd8fda..8ea5f05 100644 --- a/blog/2021-03-19-clone-github-repos.org +++ b/content/blog/2021-03-19-clone-github-repos.md @@ -1,10 +1,11 @@ -#+title: How to Clone All Repositories from a GitHub or Sourcehut Account -#+date: 2021-03-19 ++++ +date = 2021-03-19 +title = "How to Clone All Repositories from a GitHub or Sourcehut Account" +description = "Learn how to clone all GitHub or Sourcehut repositories." ++++ + +## Cloning from GitHub -** Cloning from GitHub -:PROPERTIES: -:CUSTOM_ID: cloning-from-github -:END: If you're like me and use a lot of different devices (and sometimes decide to just wipe your device and start with a new OS), you probably know the pain of cloning all your old code repositories down to your @@ -12,48 +13,47 @@ local file system. If you're using GitHub, you can easily clone all of your code back down in just seconds. First, create a bash script. I do so by opening a new -file in =nano=, but you can use =gedit=, =vim=, or something else: +file in `nano`, but you can use `gedit`, +`vim`, or something else: -#+begin_src sh +```sh nano clone_github_repos.sh -#+end_src +``` Next, paste in the following information. Note that you can replace the -word =users= in the first line with =orgs= and type an organization's -name instead of a user's name. +word `users` in the first line with `orgs` and +type an organization's name instead of a user's name. -#+begin_src sh +```sh CNTX=users; NAME=YOUR-USERNAME; PAGE=1 curl "https://api.github.com/$CNTX/$NAME/repos?page=$PAGE&per_page=100" | grep -e 'git_url*' | - cut -d \" -f 4 | + cut -d " -f 4 | xargs -L1 git clone -#+end_src +``` Finally, save the bash script and make it executable. -#+begin_src sh +```sh chmod a+x clone_github_repos.sh -#+end_src +``` Now you can run the script and should see the cloning process begin. -#+begin_src sh +```sh ./clone_github_repos.sh -#+end_src +``` + +## Cloning from Sourcehut -** Cloning from Sourcehut -:PROPERTIES: -:CUSTOM_ID: cloning-from-sourcehut -:END: I haven't fully figured out how to directly incorporate Sourcehut's GraphQL API into a bash script yet, so this one will take two steps. -First, log-in to Sourcehut and go to their -[[https://git.sr.ht/graphql][GraphQL playground for Git]]. Next, paste -the following query into the left box: +First, log-in to Sourcehut and go to their [GraphQL playground for +Git](https://git.sr.ht/graphql). Next, paste the following query into +the left box: -#+begin_src sh +```sh query { me { canonicalName @@ -65,7 +65,7 @@ query { } } } -#+end_src +``` The output on the right side will give you an object of all your repositories. Just grab that text and remove all the characters such as @@ -74,18 +74,19 @@ space-separated values for the next step. Now let's create the bash script: -#+begin_src sh +```sh nano clone_sourcehut_repos.sh -#+end_src +``` Next, paste the following bash script in with the list of repositories -you obtained above and replace =your-username= with your username. +you obtained above and replace `your-username` with your +username. Note that this uses the SSH-based Git cloning method (e.g. =git@git...=), so you'll need to ensure you have set up Sourcehut with your SSH key. -#+begin_src sh +```sh repos=(repo1 repo2 repo3) # List all sub-directories in the current directory @@ -94,38 +95,37 @@ do # Clone git clone git@git.sr.ht:~your-username/$repo done -#+end_src +``` Finally, save the bash script and make it executable. -#+begin_src sh +```sh chmod a+x clone_sourcehut_repos.sh -#+end_src +``` Now you can run the script and should see the cloning process begin. -#+begin_src sh +```sh ./clone_sourcehut_repos.sh -#+end_src +``` + +## Moving Repositories to a New Host -** Moving Repositories to a New Host -:PROPERTIES: -:CUSTOM_ID: moving-repositories-to-a-new-host -:END: Now that you have all of your code repositories cloned to your local computer, you may want to change the remote host (e.g., moving from GitHub to GitLab). To do this, let's create another bash script: -#+begin_src sh +```sh nano change_remote_urls.sh -#+end_src +``` Past the following information and be sure to change the URL information to whichever host you are moving to. For this example, I am looping through all of my cloned GitHub directories and changing them to -Sourcehut (e.g. =<YOUR_NEW_REMOTE_URL>= -> =git@git.sr.ht:~myusername=). +Sourcehut (e.g. `<YOUR_NEW_REMOTE_URL>` -\> +`git@git.sr.ht:~myusername`). -#+begin_src sh +```sh # List all sub-directories in the current directory for dir in */ do @@ -140,16 +140,16 @@ do # Go back to main directory cd .. done -#+end_src +``` Finally, save the bash script and make it executable. -#+begin_src sh +```sh chmod a+x change_remote_urls.sh -#+end_src +``` Now you can run the script and should see the cloning process begin. -#+begin_src sh +```sh ./change_remote_urls.sh -#+end_src +``` diff --git a/blog/2021-03-28-gemini-capsule.org b/content/blog/2021-03-28-gemini-capsule.md index d1ebcf7..877479a 100644 --- a/blog/2021-03-28-gemini-capsule.org +++ b/content/blog/2021-03-28-gemini-capsule.md @@ -1,29 +1,30 @@ -#+title: Launching a Gemini Capsule -#+date: 2021-03-28 - -** What is Gemini? -:PROPERTIES: -:CUSTOM_ID: what-is-gemini -:END: -[[https://gemini.circumlunar.space/][Gemini]] is an internet protocol ++++ +date = 2021-03-28 +title = "Launching a Gemini Capsule" +description = "A guide to self-hosting a Gemini capsule on your own server." ++++ + +## What is Gemini? + +[Gemini](https://gemini.circumlunar.space/) is an internet protocol introduced in June 2019 as an alternative to HTTP(S) or Gopher. In layman's terms, it's an alternative way to browse sites (called capsules) that requires a special browser. Since Gemini is not standardized as an internet standard, normal web browsers won't be able -to load a Gemini capsule. Instead, you'll need to use -[[https://gemini.%20circumlunar.space/clients.html][a Gemini-specific -browser]]. +to load a Gemini capsule. Instead, you'll need to use [a +Gemini-specific +browser](https://gemini.%20circumlunar.space/clients.html). The content found within a Gemini page is called -[[https://gemini.circumlunar.space/docs/cheatsheet.gmi][Gemtext]] and is -/extremely/ basic (on purpose). Gemini only processes the text, no media -content like images. However, you're able to style 3 levels of headings, -regular text, links (which will display on their own line), quotes, and -an unordered list. +[Gemtext](https://gemini.circumlunar.space/docs/cheatsheet.gmi) and is +*extremely* basic (on purpose). Gemini only processes the text, no media +content like images. However, you're able to style 3 levels of +headings, regular text, links (which will display on their own line), +quotes, and an unordered list. Here's a complete listing of valid Gemtext: -#+begin_src txt +```txt # Heading 1 ## Heading 2 ### Heading 3 @@ -40,12 +41,10 @@ My List: * Item ```Anything between three backticks will be rendered as code.``` -#+end_src +``` + +## Free Option -** Free Option -:PROPERTIES: -:CUSTOM_ID: free-option -:END: There are probably numerous websites that allow you to create your personal Gemini capsule, but I'm going to focus on the two sites that I have personally tested. The first option below, Midnight Pub, allows you @@ -55,20 +54,18 @@ second option below, Sourcehut, allows you to use a Git repository and automatic build process to deploy your personal Gemini capsule every time you push a commit. -*** Midnight Pub - Beginner Friendly -:PROPERTIES: -:CUSTOM_ID: midnight-pub---beginner-friendly -:END: -[[https://midnight.pub/][Midnight Pub]] is a small, virtual community +### Midnight Pub - Beginner Friendly + +[Midnight Pub](https://midnight.pub/) is a small, virtual community meant to reflect the atmosphere of wandering into a small alley pub. The site is built in Gemtext and has a server-side process to convert Gemtext to HTML if someone loads the site in an HTTP(S) browser. To create an account, you'll need to email the owner of the website to obtain a key. You can find their email on the Midnight Pub homepage. -Once registered, head to [[https://midnight.pub/account][your account]] -and select [[https://midnight.pub/site][manage site]]. This is the -screen where you can upload or create any files to be displayed on the +Once registered, head to [your account](https://midnight.pub/account) +and select [manage site](https://midnight.pub/site). This is the screen +where you can upload or create any files to be displayed on the internet. For example, I've created both an HTML file and a Gemini file. Remember @@ -76,25 +73,22 @@ that Gemini is automatically converted to HTML on the Pub, so you don't need an HTML version. For example, I created an HTML version to add in some extra styling. -All you need to do is create a page like =index.gmi= and use your Gemini -browser to head over to your-username.midnight.pub to see the result. +All you need to do is create a page like `index.gmi` and use +your Gemini browser to head over to your-username.midnight.pub to see +the result. That's all there is to it! Easy enough, right? Let's check out a more advanced version in the next section. -** Paid Option -:PROPERTIES: -:CUSTOM_ID: paid-option -:END: +## Paid Option + As of 2021, Sourcehut has decided to require users to have a paid account in order to utilize their automated build system. For now, paid -accounts can be as low as $2/month. +accounts can be as low as \$2/month. + +### Sourcehut -*** Sourcehut -:PROPERTIES: -:CUSTOM_ID: sourcehut -:END: -[[https://sourcehut.org/][Sourcehut]] is a collection of software +[Sourcehut](https://sourcehut.org/) is a collection of software development tools, but mostly surrounds their hosted Git repository service. Simply put, it's a minimal and more private alternative to services like GitHub. @@ -106,43 +100,43 @@ instead. The first thing you'll need to do is create an SSH key pair, if you don't already have one on your system. Once created, grab the contents -of =id_rsa.pub= and add it to your Sourcehut account settings - this -will allow you to push and pull code changes without using a -username/password. +of `id_rsa.pub` and add it to your Sourcehut account +settings - this will allow you to push and pull code changes without +using a username/password. -#+begin_src sh +```sh ssh keygen -#+end_src +``` Next up, let's create a repository with the proper name so that the Sourcehut build system will know we want them to host a website for us. Use the following format exactly: -#+begin_src sh +```sh mkdir your-username.srht.site && cd your-username.srht.site -#+end_src +``` -Now that we've created the repo, let's initialize Git and add the proper -remote URL. +Now that we've created the repo, let's initialize Git and add the +proper remote URL. -#+begin_src sh +```sh git init -#+end_src +``` -#+begin_src sh +```sh git remote add origin git@git.sr.ht:~your-username/your-username.srht.site -#+end_src +``` Now that our repository is set up and configured, we will need to create at least two files: -- =index.gmi= -- =.build.yml= +- `index.gmi` +- `.build.yml` -For your =.build.yml= file, use the following content and be sure to -update the =site= line with your username! +For your `.build.yml` file, use the following content and be +sure to update the `site` line with your username! -#+begin_src yaml +```yaml image: alpine/latest oauth: pages.sr.ht/PAGES:RW environment: @@ -153,38 +147,39 @@ tasks: tar -cvz . > ../site.tar.gz - upload: | acurl -f https://pages.sr.ht/publish/$site -Fcontent=@site.tar.gz -Fprotocol=GEMINI -#+end_src +``` -For the =index.gmi= file, put whatever you want in there and save it. -You could even just copy and paste the Gemtext cheatsheet. +For the `index.gmi` file, put whatever you want in there and +save it. You could even just copy and paste the Gemtext cheatsheet. If you want to serve both HTML and Gemini files from this repository, -just add a second command to the =upload= section: +just add a second command to the `upload` section: -#+begin_src yaml +```yaml - upload: | acurl -f https://pages.sr.ht/publish/$site -Fcontent=@site.tar.gz -Fprotocol=GEMINI acurl -f https://pages.sr.ht/publish/$site -Fcontent=@site.tar.gz -#+end_src +``` Lastly, commit your changes and push them to the remote repo. -#+begin_src sh +```sh git add .; git commit -m "initial commit"; git push --set-upstream origin HEAD -#+end_src +``` -If you've successfully created the files with the proper format, you'll -see the terminal print a message that lets you know where the automatic -build is taking place. For example, here's what the terminal tells me: +If you've successfully created the files with the proper format, +you'll see the terminal print a message that lets you know where the +automatic build is taking place. For example, here's what the terminal +tells me: -#+begin_src sh +```sh remote: Build started: remote: https://builds.sr.ht/~user/job/689803 [.build.yml] -#+end_src +``` Now that you've properly built your Sourcehut page, you can browse to your-username.srht.site in a Gemini browser and view the final results. Take a look at the image below for my Sourcehut Gemini capsule. -#+caption: Gemini page on the amfora browser -[[https://img.cleberg.net/blog/20210328-launching-a-gemini-capsule/amfora.png]] + diff --git a/blog/2021-03-28-vaporwave-vs-outrun.org b/content/blog/2021-03-28-vaporwave-vs-outrun.md index b12f472..efad32f 100644 --- a/blog/2021-03-28-vaporwave-vs-outrun.org +++ b/content/blog/2021-03-28-vaporwave-vs-outrun.md @@ -1,10 +1,11 @@ -#+title: Vaporwave vs Outrun -#+date: 2021-03-28 ++++ +date = 2021-03-28 +title = "Vaporwave vs Outrun" +description = "Learn the differences between the vaporwave and Outrun aesthetics." ++++ + +## Overview -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: When it comes to an aesthetic that originated primarily online, there tends to be a lot of confusion around what falls into each specific genre. This post discusses Vaporwave and Outrun, which have become @@ -12,69 +13,58 @@ almost synonymous in the minds of those online who aren't hardcore into these genres of media. More specifically, Outrun is largely an unknown term while all aesthetics in these two genres are usually attributed to Vaporwave. For example, take a look at the image search results for -Vaporwave: the results include *a lot* of Outrun-themed images. You'll -find a similar trend almost everywhere. +Vaporwave: the results include **a lot** of Outrun-themed images. +You'll find a similar trend almost everywhere. + + -[[https://img.cleberg.net/blog/20210328-vaporwave-vs-outrun/vaporwave-search-results.png]] +## Vaporwave -** Vaporwave -:PROPERTIES: -:CUSTOM_ID: vaporwave -:END: -[[https://img.cleberg.net/blog/20210328-vaporwave-vs-outrun/macintosh-plus.png]] + Okay, so what is Vaporwave? I'm going to just copy-and-paste some general info from the Wikipedia article on -[[https://en.wikipedia.org/wiki/Vaporwave][Vaporwave]], so that I'm not +[Vaporwave](https://en.wikipedia.org/wiki/Vaporwave), so that I'm not repeating everything you can already search for online: -#+begin_quote -Vaporwave is a microgenre of electronic music, a visual art style, and -an Internet meme that emerged in the early 2010s. It is defined partly -by its slowed-down, chopped and screwed samples of smooth jazz, -elevator, R&B, and lounge music from the 1980s and 1990s. The -surrounding subculture is sometimes associated with an ambiguous or -satirical take on consumer capitalism and pop culture, and tends to be -characterized by a nostalgic or surrealist engagement with the popular -entertainment, technology and advertising of previous decades. Visually, -it incorporates early Internet imagery, late 1990s web design, glitch -art, anime, 3D-rendered objects, and cyberpunk tropes in its cover -artwork and music videos. - -#+end_quote +> Vaporwave is a microgenre of electronic music, a visual art style, and +> an Internet meme that emerged in the early 2010s. It is defined partly +> by its slowed-down, chopped and screwed samples of smooth jazz, +> elevator, R&B, and lounge music from the 1980s and 1990s. The +> surrounding subculture is sometimes associated with an ambiguous or +> satirical take on consumer capitalism and pop culture, and tends to be +> characterized by a nostalgic or surrealist engagement with the popular +> entertainment, technology and advertising of previous decades. +> Visually, it incorporates early Internet imagery, late 1990s web +> design, glitch art, anime, 3D-rendered objects, and cyberpunk tropes +> in its cover artwork and music videos. This is an excellent summary, and it helps address my point here: there are specific aspects that make Vaporwave unique: -*** Time Frame -:PROPERTIES: -:CUSTOM_ID: time-frame -:END: +### Time Frame + The time frame for references, logos, etc. focuses mostly on the 1990s in Vaporwave. You'll see old school Pepsi logos, Microsoft 95 screens, tropical plants, classic marble sculptures, and many references from Japan's influence in the 90s. -*** Art -:PROPERTIES: -:CUSTOM_ID: art -:END: +### Art + The color scheme is generally a soft, light palette that uses pastel colors. The backdrop will often be in a light-pink or teal blue. -*** Music -:PROPERTIES: -:CUSTOM_ID: music -:END: +### Music + The musical genre of Vaporwave incorporates soft tunes, lounge music, and sound effects that will make the listener reminisce of the 90s. The sounds of the genre are generally slower-paced and calming. The major -breakthrough artist for Vaporwave was -[[https://en.wikipedia.org/wiki/Vektroid][Macintosh Plus]], who released -the album -[[https://archive.org/details/MACINTOSHPLUS-FLORALSHOPPE_complete][Floral -Shoppe]] in 2011. Another more recent example is the artist -[[https://sadbert.bandcamp.com/][sadbert]], whose latest album +breakthrough artist for Vaporwave was [Macintosh +Plus](https://en.wikipedia.org/wiki/Vektroid), who released the album +[Floral +Shoppe](https://archive.org/details/MACINTOSHPLUS-FLORALSHOPPE_complete) +in 2011. Another more recent example is the artist +[sadbert](https://sadbert.bandcamp.com/), whose latest album incorporates the upbeat tones of the 1999 Dilbert TV series. Notice that Vaporwave doesn't include things like racing cars, @@ -84,30 +74,23 @@ was becoming common in households, a reality that we have already experienced. Focus on the most aesthetically-pleasing parts of that past is a large part of Vaporwave. -** Outrun -:PROPERTIES: -:CUSTOM_ID: outrun -:END: -#+caption: Outrun -[[https://img.cleberg.net/blog/20210328-vaporwave-vs-outrun/outrun.png]] +## Outrun + + Now, let's get to Outrun. This one is a little trickier since the genre has largely been lumped under the Vaporwave title for so long. However, -it stems from the [[https://en.wikipedia.org/wiki/Synthwave][Synthwave]] -music genre and is likely named after the 1986 racer game, -[[https://en.wikipedia.org/wiki/Out_Run][Out Run]]. - -*** Time Frame -:PROPERTIES: -:CUSTOM_ID: time-frame-1 -:END: +it stems from the [Synthwave](https://en.wikipedia.org/wiki/Synthwave) +music genre and is likely named after the 1986 racer game, [Out +Run](https://en.wikipedia.org/wiki/Out_Run). + +### Time Frame + Outrun can be thought of as a retro-futuristic aesthetic born from the 1980s. -*** Art -:PROPERTIES: -:CUSTOM_ID: art-1 -:END: +### Art + The color scheme uses a very dark color palette with the main colors being deep oranges, blues, and purples. Red edges are common around objects in Outrun art. The background of the Outrun aesthetic is almost @@ -118,10 +101,8 @@ Classic sports cars, chrome robots, computer generated graphics and fonts, and the occasional use of rain or palm trees can be found in Outrun art. -*** Music -:PROPERTIES: -:CUSTOM_ID: music-1 -:END: +### Music + This aesthetic has a more aggressive and fast-paced style of music, which tends to match the subject of the art in this aesthetic. @@ -129,22 +110,20 @@ Outrun enthusiasts love what people in the 1980s thought the future would look like. Take a look at a common video game discussed in Outrun circles, Far Cry 3: Blood Dragon: -#+caption: Fry Cry 3: Blood Dragon -[[https://img.cleberg.net/blog/20210328-vaporwave-vs-outrun/far-cry.png]] + Another example that doesn't force the color scheme as hard as some online art does is Kung Fury: -#+caption: Kung Fury -[[https://img.cleberg.net/blog/20210328-vaporwave-vs-outrun/kung-fury.png]] + + + -#+caption: Kung Fury Hacker Scene -[[https://img.cleberg.net/blog/20210328-vaporwave-vs-outrun/kung-fury-hacker.png]] +## Conclusion -** Conclusion -:PROPERTIES: -:CUSTOM_ID: conclusion -:END: While Vaporwave and Outrun share similarities, they are two distinct aesthetics with many important distinctions. Someone who enjoys one may not necessarily enjoy the other, so it's important to make sure we diff --git a/blog/2021-03-30-vps-web-server.org b/content/blog/2021-03-30-vps-web-server.md index 147b86f..8914d73 100644 --- a/blog/2021-03-30-vps-web-server.org +++ b/content/blog/2021-03-30-vps-web-server.md @@ -1,35 +1,35 @@ -#+title: How to Set Up a VPS Web Server -#+date: 2021-03-30 ++++ +date = 2021-03-30 +title = "How to Set Up a VPS Web Server" +description = "A beginner's guide to setting up a virtual private server (VPS)." ++++ + +## Shared Hosting vs. VPS -** Shared Hosting vs. VPS -:PROPERTIES: -:CUSTOM_ID: shared-hosting-vs.-vps -:END: Choosing a place to host a website is one of the most confusing decisions for beginner web developers. Even for experienced web devs, choosing between different forms of web hosting can be a daunting choice. -First, let's take a look at -[[https://en.wikipedia.org/wiki/Shared_web_hosting_service][shared web -hosting]]. Shared web hosting is a product where you are purchasing a -small piece of a web server that is being shared between many websites. -As a result, the cost of shared hosting is extremely low. You won't have -access to the server itself, which means you can't install your own -software on the server, such as Docker. Usually, you are simply allowed -to connect your domains to the server, set up domain security, and other -small utilities. - -In contrast, a -[[https://en.wikipedia.org/wiki/Virtual_private_server][virtual private -server]] (VPS) is a virtual machine that replicates the environment of -having a dedicated server to yourself. You are able to control the -virtual server's host names, base file system, package manager, etc. -Another great upside of a VPS is that since it's virtual, the company -providing the VPS can dynamically increase the disk size, RAM size, or -number of CPUs at any time. However, the virtual server is still -physically located on a server that is shared between multiple virtual -servers. +First, let's take a look at [shared web +hosting](https://en.wikipedia.org/wiki/Shared_web_hosting_service). +Shared web hosting is a product where you are purchasing a small piece +of a web server that is being shared between many websites. As a result, +the cost of shared hosting is extremely low. You won't have access to +the server itself, which means you can't install your own software on +the server, such as Docker. Usually, you are simply allowed to connect +your domains to the server, set up domain security, and other small +utilities. + +In contrast, a [virtual private +server](https://en.wikipedia.org/wiki/Virtual_private_server) (VPS) is a +virtual machine that replicates the environment of having a dedicated +server to yourself. You are able to control the virtual server's host +names, base file system, package manager, etc. Another great upside of a +VPS is that since it's virtual, the company providing the VPS can +dynamically increase the disk size, RAM size, or number of CPUs at any +time. However, the virtual server is still physically located on a +server that is shared between multiple virtual servers. The choice between shared hosting and VPS mostly depends on your skill level with system administration. If you're comforting working on a @@ -38,10 +38,8 @@ a VPS is usually a better option. However, shared hosting is a fantastic option for people who don't want to have to learn how to manage their server. -** My Situation -:PROPERTIES: -:CUSTOM_ID: my-situation -:END: +## My Situation + I had used shared hosting for approximately 5 years before trying my first VPS. I manage a homelab and have had success running a server and performing typical sysadmin duties, but I was still hesitant to get a @@ -50,54 +48,49 @@ networking part of a server - DNS and hostname configurations were not my friend. As a little bit of background, I originally used -[[https://www.siteground.com][Siteground]] for my initially shared -hosting and stayed on that platform for at least a year. However, the UI -was clunky, and I didn't like how they handled certain technical -aspects, so I switched to [[https://www.namecheap.com][Namecheap]]. -Namecheap was great because it is the service I primarily use for -purchasing domain names, which made it incredibly easy to link them to -my hosting service. However, it was still mediocre shared hosting, and -Namecheap is notorious for not letting you use -[[https://letsencrypt.org][Let's Encrypt]] to obtain free SSL/TLS -certificates; Namecheap wants to make you purchase certificates through -their store. - -Finally, I settled down with [[https://www.iwebfusion.net][iWebFusion]] +[Siteground](https://www.siteground.com) for my initially shared hosting +and stayed on that platform for at least a year. However, the UI was +clunky, and I didn't like how they handled certain technical aspects, +so I switched to [Namecheap](https://www.namecheap.com). Namecheap was +great because it is the service I primarily use for purchasing domain +names, which made it incredibly easy to link them to my hosting service. +However, it was still mediocre shared hosting, and Namecheap is +notorious for not letting you use [Let's +Encrypt](https://letsencrypt.org) to obtain free SSL/TLS certificates; +Namecheap wants to make you purchase certificates through their store. + +Finally, I settled down with [iWebFusion](https://www.iwebfusion.net) for about the last year of my shared hosting. This service was pretty great, came with free SSL/TLS, and I never had any complaints. However, I finally grew tired of not being able to install software on my own web server. I wanted to be able to try out things like -[[https://postmill.xyz][Postmill]] or [[https://matrix.org][Matrix]]. -This is possible with a VPS, so I decided to grab a new domain name to -try it out. - -** Getting Started: Buying a VPS -:PROPERTIES: -:CUSTOM_ID: getting-started-buying-a-vps -:END: +[Postmill](https://postmill.xyz) or [Matrix](https://matrix.org). This +is possible with a VPS, so I decided to grab a new domain name to try it +out. + +## Getting Started: Buying a VPS + The first step to moving over to a VPS is (you guessed it): finding a -VPS provider. For my VPSs, I use [[https://1984hosting.com][1984]] and +VPS provider. For my VPSs, I use [1984](https://1984hosting.com) and prefer their services much more than any alternative, due to their -location (Iceland), their [[https://1984hosting.com/GDPR/][privacy -policy]], their respect for GDPR, and the ability to remain anonymous if -you pay in Bitcoin or Monero. +location (Iceland), their [privacy +policy](https://1984hosting.com/GDPR/), their respect for GDPR, and the +ability to remain anonymous if you pay in Bitcoin or Monero. -[[https://njal.la][Njalla]] is another good, privacy-oriented option for +[Njalla](https://njal.la) is another good, privacy-oriented option for VPS services. You'll have to decide what specifications you want on your VPS. For me, I only build and deploy low-resource HTML, PHP, and Python websites. This means I can survive on the smallest VPS: 1 CPU, 1GB of RAM, and -25GB SSD for $5.00 per month. +25GB SSD for \$5.00 per month. As noted above, the great thing about a VPS is you can request your provider to increase the resources at any time. -** Configuring DNS Settings -:PROPERTIES: -:CUSTOM_ID: configuring-dns-settings -:END: +## Configuring DNS Settings + Okay, so now let's get into some actual work that has to be done to get content moved from a shared host to a VPS. At this point, I'm assuming you have a shared host with website content that you can still access, @@ -105,147 +98,143 @@ and you've purchased a new VPS and can SSH into that server. The first change is minor, but it should be done immediately in order to get things moving: DNS settings. Go to wherever your DNS settings are -handled. If your shared host also managed your DNS settings, you'll need -to first move that DNS over to your new VPS provider. For me, I route my -DNS through [[https://www.gandi.net][Gandi]]. +handled. If your shared host also managed your DNS settings, you'll +need to first move that DNS over to your new VPS provider. For me, I +route my DNS through [Gandi](https://www.gandi.net). -Once you know where your DNS settings are, go ahead and update the =A= -records to match the public IP address of your VPS. For example: +Once you know where your DNS settings are, go ahead and update the +`A` records to match the public IP address of your VPS. For +example: -#+begin_src txt +```txt A example.com xxx.xxx.xxx.xxx A subdomain xxx.xxx.xxx.xxx CNAME www example.com. -#+end_src +``` If you have any other records that require updates, such as MX or TXT records for a mail server, be sure to update those accordingly. Personally, I don't host my own mail server. I route all mail on my -custom domains to [[https://www.migadu.com][Migadu]]. Hosting your own +custom domains to [Migadu](https://www.migadu.com). Hosting your own email server can become complex quickly and is not for beginners. DNS changes can take up to 48 hours to propagate, so be sure to give it some time before assuming you've made an error. -** Server Updates and Packages -:PROPERTIES: -:CUSTOM_ID: server-updates-and-packages -:END: +## Server Updates and Packages + Now that the DNS settings have been changed, let's set up our server while we wait for the DNS to propagate. First up is to ssh into your server. If you've signed up with a service like DigitalOcean, you can add your SSH key to your account and to your VPS droplet so that you don't need a password in order to SSH. -#+begin_src sh +```sh ssh root@xxx.xxx.xxx.xxx -#+end_src +``` The VPS that is used in this blog post runs Ubuntu 20.04 with an Apache web server. If you're working on a different operating system (OS) or -want a different web server, such as Nginx, you'll have to use different -commands to set it up. +want a different web server, such as Nginx, you'll have to use +different commands to set it up. First, let's update and upgrade our server. -*NOTE:* Since we have logged in to the server as =root= for now, we -don't need to use the =sudo= modifier before our commands. +**NOTE:** Since we have logged in to the server as `root` for +now, we don't need to use the `sudo` modifier before our +commands. -#+begin_src sh +```sh apt update && apt upgrade -y -#+end_src +``` + +## Create A User Account -** Create A User Account -:PROPERTIES: -:CUSTOM_ID: create-a-user-account -:END: -While being able to use =root= can be beneficial at times, you shouldn't -use =root= unless you have to. +While being able to use `root` can be beneficial at times, +you shouldn't use `root` unless you have to. -So let's set up a new user in our system. The =-m= option below tells -the OS to create a home directory for the new user. +So let's set up a new user in our system. The `-m` option +below tells the OS to create a home directory for the new user. -#+begin_src sh +```sh adduser USERNAME -#+end_src +``` Now, create a password for that user. -#+begin_src sh +```sh passwd USERNAME -#+end_src +``` Finally, add the user to the sudoers file, so they can perform priveleged commands. -#+begin_src sh +```sh usermod -a -G sudo USERNAME -#+end_src +``` If you are using SSH keys and not passwords, you'll need to copy your SSH key from your local machine to the VPS. If you haven't disabled -password-based SSH yet, the easiest way to do this is =ssh-copy-id= from -your local computer (not from the VPS): +password-based SSH yet, the easiest way to do this is +`ssh-copy-id` from your local computer (not from the VPS): -#+begin_src sh +```sh ssh-copy-id testuser@xxx.xxx.xxx.xxx -#+end_src +``` -If you've disabled password-based SSH, you'll need to manually copy your -SSH key into the =~/.ssh/authorized_keys= file. +If you've disabled password-based SSH, you'll need to manually copy +your SSH key into the `~/.ssh/authorized_keys` file. + +## Install Software -** Install Software -:PROPERTIES: -:CUSTOM_ID: install-software -:END: Our goal here is to host a web server, so the next step is to install the Apache web server and any other packages we need. -From this point on, I will be logged in as a user (not =root=) and will -need to use the =sudo= modifier for most commands. +From this point on, I will be logged in as a user (not +`root`) and will need to use the `sudo` modifier +for most commands. -#+begin_src sh +```sh sudo apt update; sudo apt upgrade -y; sudo apt autoremove -y sudo apt install apache2 -#+end_src +``` If you need other language support, such as PHP, you'll need to install that too. -#+begin_src sh +```sh sudo apt install libapache2-mod-php php-dom sudo a2enmod php sudo systemctl restart apache2 -#+end_src +``` + +## Website Files & Folders -** Website Files & Folders -:PROPERTIES: -:CUSTOM_ID: website-files-folders -:END: Next up is to create the directories for the domain(s) we want to be hosted on this web server. -#+begin_src sh +```sh cd /var/www sudo mkdir example.com -#+end_src +``` -We have a folder for =example.com= now, so let's add an =index.html= -file and put it within a specific =public_html= folder. You don't need -this =public_html= if you don't want it, but it helps with organizing -items related to =example.com= that you don't want to publish to the -internet. +We have a folder for `example.com` now, so let's add an +`index.html` file and put it within a specific +`public_html` folder. You don't need this +`public_html` if you don't want it, but it helps with +organizing items related to `example.com` that you don't +want to publish to the internet. -#+begin_src sh +```sh cd example.com sudo mkdir public_html && cd public_html sudo nano index.html -#+end_src +``` -You can put anything you want in this =index.html= file. If you can't -think of anything, paste this in there: +You can put anything you want in this `index.html` file. If +you can't think of anything, paste this in there: -#+begin_src html +```html <!DOCTYPE html> <html lang="en"> <head> @@ -257,37 +246,36 @@ think of anything, paste this in there: <h1>Hello, world!</h1> </body> </html> -#+end_src +``` -If you want something to be served at =example.com/page01/file.txt=, -you'll have to create the =page01= directory under the =example.com= +If you want something to be served at +`example.com/page01/file.txt`, you'll have to create the +`page01` directory under the `example.com` directory. For example: -#+begin_src sh +```sh cd /var/www/example.com/public_html sudo mkdir page01 sudo nano file.txt -#+end_src +``` + +## Apache Configuration -** Apache Configuration -:PROPERTIES: -:CUSTOM_ID: apache-configuration -:END: Now, let's set up the files that will tell the server where to find the -files for =example.com=. We will copy the default configuration file and -create our own. +files for `example.com`. We will copy the default +configuration file and create our own. -#+begin_src sh +```sh cd /etc/apache2/sites-available sudo cp 000-default.conf example.com.conf sudo nano example.com.conf -#+end_src +``` This configuration file will have a few default lines, but you'll need to edit it to look similar to this (settings may change based on your personal needs): -#+begin_src config +```config <VirtualHost *:80> ServerAdmin your-email@email-provider.com ServerName example.com @@ -296,85 +284,85 @@ personal needs): ErrorLog ${APACHE_LOG_DIR}/error.log CustomLog ${APACHE_LOG_DIR}/access.log combined </VirtualHost> -#+end_src +``` Now, enable the configuration for your new site, disable the default configuration, and reload the web server. -#+begin_src sh +```sh sudo a2ensite example.com.conf sudo a2dissite 000-default.conf sudo systemctl reload apache2 -#+end_src +``` You can always run a test to make sure no errors or warnings are found in your configuration files. -#+begin_src sh +```sh sudo apache2ctl configtest -#+end_src +``` Now, restart the web server entirely. After this, you should be able to -browse to =http://example.com= and see the HTML content you provided -earlier. Note that SSL/TLS has not been enabled yet, so you won't be -able to use the secure version yet (=https://example.com=). +browse to `http://example.com` and see the HTML content you +provided earlier. Note that SSL/TLS has not been enabled yet, so you +won't be able to use the secure version yet +(`https://example.com`). -#+begin_src sh +```sh sudo systemctl restart apache2 -#+end_src +``` You can repeat this for as many websites as you need. Just create the -domain folders in =/var/www/=, add the configuration file, enable the -configuration, and restart =apache2=. +domain folders in `/var/www/`, add the configuration file, +enable the configuration, and restart `apache2`. + +## SSL/TLS Certificates: Serve Websites Over HTTPS -** SSL/TLS Certificates: Serve Websites Over HTTPS -:PROPERTIES: -:CUSTOM_ID: ssltls-certificates-serve-websites-over-https -:END: In order to serve secure content, you'll need to obtain SSL/TLS certificates. Luckily, there's a free tool called -[[https://certbot.eff.org][Certbot]] that helps us with the process. +[Certbot](https://certbot.eff.org) that helps us with the process. -The first step is to install =snapd= and =core= for Ubuntu. +The first step is to install `snapd` and `core` +for Ubuntu. -#+begin_src sh +```sh sudo apt install snapd sudo snap install core sudo snap refresh core -#+end_src +``` -Next, install the =certbot= snap package. +Next, install the `certbot` snap package. -#+begin_src sh +```sh sudo snap install --classic certbot -#+end_src +``` -Execute the following command to ensure that the =certbot= command can -be run. +Execute the following command to ensure that the `certbot` +command can be run. -#+begin_src sh +```sh sudo ln -s /snap/bin/certbot /usr/bin/certbot -#+end_src +``` -Finally, you can run =certbot= one of two ways: +Finally, you can run `certbot` one of two ways: -1. run it and let it alter your Apache configuration files automatically - to enable HTTPS redirects. -2. run it and only allow it to create certificates. You'll need to - manually alter the config files to enable HTTPS redirects. +1. run it and let it alter your Apache configuration files + automatically to enable HTTPS redirects. +2. run it and only allow it to create certificates. You'll need to + manually alter the config files to enable HTTPS redirects. Run certbot and allow automatic config changes: -#+begin_src sh +```sh sudo certbot --apache -#+end_src +``` Run certbot for certificates only and don't allow it to alter config files: -#+begin_src sh +```sh sudo certbot certonly --apache -#+end_src +``` The Certbot packages on your system come with a cron job or systemd timer that will renew your certificates automatically before they @@ -382,52 +370,48 @@ expire. You will not need to run Certbot again unless you change your configuration. You can test automatic renewal for your certificates by running this command: -#+begin_src sh +```sh sudo certbot renew --dry-run -#+end_src +``` + +Now, test your domains by going to `https://example.com`. -Now, test your domains by going to =https://example.com=. +## Firewall Security -** Firewall Security -:PROPERTIES: -:CUSTOM_ID: firewall-security -:END: To enable better security on your server, you'll need to enable a basic -firewall. For Ubuntu, we'll use -[[https://cleberg.net/blog/secure-your-network-with-the-uncomplicated-firewall.html][the -uncomplicated firewall]]. +firewall. For Ubuntu, we'll use [the uncomplicated +firewall](https://cleberg.net/blog/secure-your-network-with-the-uncomplicated-firewall.html). Now, add the following rules to the firewall allow SSH, Apache, and HTTP(S) connections. If you need to, you can enable different ports for specifics applications, SFTP, etc. -#+begin_src sh +```sh sudo ufw default deny incoming sudo ufw default allow outgoing sudo ufw allow OpenSSH sudo ufw allow Apache sudo ufw allow proto tcp from any to any port 80,443 -#+end_src +``` Once you've added all the rules you need, enable the firewall. -#+begin_src sh +```sh sudo ufw enable -#+end_src +``` + +## Troubleshooting -** Troubleshooting -:PROPERTIES: -:CUSTOM_ID: troubleshooting -:END: If you run into any issues during your VPS set-up, be sure to walk back through your actions and make sure you didn't miss any steps. Many websites have fantastic guides to setting up various web servers. -This is one of the areas -[[https://www.digitalocean.%20com/community/tutorials][where -DigitalOcean shines]]. For simpler or more Linux-oriented questions, I -suggest using [Linuxize] (https://linuxize.com). +This is one of the areas [where DigitalOcean +shines](https://www.digitalocean.%20com/community/tutorials). For +simpler or more Linux-oriented questions, I suggest using [Linuxize] +(<https://linuxize.com>). If you're getting certain errors (e.g. =500 Internal Server Error=) and -need to debug locally, you can view the =access.log= and =error.log= -files in the =/var/log/apache/= directory. +need to debug locally, you can view the `access.log` and +`error.log` files in the `/var/log/apache/` +directory. diff --git a/blog/2021-04-17-gemini-server.org b/content/blog/2021-04-17-gemini-server.md index 6494c9c..5618e70 100644 --- a/blog/2021-04-17-gemini-server.org +++ b/content/blog/2021-04-17-gemini-server.md @@ -1,181 +1,164 @@ -#+title: Hosting a Gemini Server -#+date: 2021-04-17 ++++ +date = 2021-04-17 +title = "Hosting a Gemini Server" +description = "A guide to self-hosting a Gemini web server on your own server." ++++ + +## Similar Article Available -** Similar Article Available -:PROPERTIES: -:CUSTOM_ID: similar-article-available -:END: To read more about Gemini and ways to test out this new protocol without -your own server, see my previous post -[[/blog/launching-a-gemini-capsule/][Launching a Gemini Capsule]]. +your own server, see my previous post [Launching a Gemini +Capsule](/blog/launching-a-gemini-capsule/). + +## Preparation -** Preparation -:PROPERTIES: -:CUSTOM_ID: preparation -:END: This guide assumes you have access to a server accessible to the world through a public IP address and that you own a domain name used for this Gemini capsule. -** Getting Started with Agate -:PROPERTIES: -:CUSTOM_ID: getting-started-with-agate -:END: -We are going to use [[https://github.com/mbrubeck/agate][Agate]] for -this tutorial. This is a basic Gemini server written in Rust. It takes -very little time and maintenance to get it running. - -** Install Dependencies -:PROPERTIES: -:CUSTOM_ID: install-dependencies -:END: +## Getting Started with Agate + +We are going to use [Agate](https://github.com/mbrubeck/agate) for this +tutorial. This is a basic Gemini server written in Rust. It takes very +little time and maintenance to get it running. + +## Install Dependencies + First, you will need to install the Rust package for your system. On -Ubuntu, use the following commands (remember to use =sudo= if you are -not the root user). The Rust installation will give you options to -customize the installation; I used the default installation options. +Ubuntu, use the following commands (remember to use `sudo` if +you are not the root user). The Rust installation will give you options +to customize the installation; I used the default installation options. -#+begin_src sh +```sh sudo apt update && sudo apt upgrade -y curl https://sh.rustup.rs -sSf | sh -#+end_src +``` Remember to configure your shell with the new configuration: -#+begin_src sh +```sh source $HOME/.cargo/env -#+end_src +``` -Before we install agate, make sure you have the =gcc= package installed: +Before we install agate, make sure you have the `gcc` package +installed: -#+begin_src sh +```sh sudo apt install gcc -#+end_src +``` Next, you'll need to install the agate executable with Rust's Cargo package maintainer: -#+begin_src sh +```sh cargo install agate -#+end_src +``` + +## Create Symlinks -** Create Symlinks -:PROPERTIES: -:CUSTOM_ID: create-symlinks -:END: Once Cargo has finished installing all the required packages, symlink -the executable to your $PATH. +the executable to your \$PATH. -#+begin_src sh +```sh sudo ln -s $HOME/.cargo/bin/agate /usr/local/bin/agate -#+end_src +``` + +## Using Agate's Built-In Installation Tool -** Using Agate's Built-In Installation Tool -:PROPERTIES: -:CUSTOM_ID: using-agates-built-in-installation-tool -:END: If you're running Ubuntu or Debian, use the Debian installation script -found in Agate's GitHub repository, under the =tools/debian= folder. +found in Agate's GitHub repository, under the `tools/debian` +folder. -#+begin_src sh +```sh git clone https://github.com/mbrubeck/agate cd agate/tools/debian sudo ./install.sh -#+end_src +``` + +## Configure the Gemini Service -** Configure the Gemini Service -:PROPERTIES: -:CUSTOM_ID: configure-the-gemini-service -:END: We have a little more to do, but since this script tries to immediately run the service, it will likely fail with an exit code. Let's add our finishing touches. Edit the following file and replace the hostname with your desired URL. You can also change the directory where content will be served. -#+begin_src sh +```sh sudo nano /etc/systemd/system/gemini.service -#+end_src +``` -#+begin_src sh +```sh # Edit these lines to whatever you want - see the next code block for my personal configuration. WorkingDirectory=/srv/gemini ExecStart=agate --hostname $(uname -n) --lang en -#+end_src +``` This is my personal config: -#+begin_src sh +```sh WorkingDirectory=/var/gemini/ ExecStart=agate --hostname gemini.example.com --lang en -#+end_src +``` Since we've altered the systemd configuration files, we have to reload the daemon. Let's do that, restart our service, and check its status. -#+begin_src sh +```sh sudo systemctl daemon-reload sudo systemctl restart gemini.service sudo systemctl status gemini.service -#+end_src +``` + +## Fixing Systemd Errors -** Fixing Systemd Errors -:PROPERTIES: -:CUSTOM_ID: fixing-systemd-errors -:END: If you're still getting errors, the installation process may not have properly enabled the gemini service. Fix it with the following commands. -#+begin_src sh +```sh sudo systemctl enable gemini.service sudo systemctl restart gemini.service sudo systemctl status gemini.service -#+end_src +``` + +## Firewall Rules -** Firewall Rules -:PROPERTIES: -:CUSTOM_ID: firewall-rules -:END: Great! Our server is now functional and running. The first consideration now is that you need to be able to access port 1965 on the server. If you have a firewall enabled, you'll need to open that port up. -#+begin_src sh +```sh sudo ufw allow 1965 sudo ufw reload -#+end_src +``` + +## Creating Content -** Creating Content -:PROPERTIES: -:CUSTOM_ID: creating-content -:END: Let's create the Gemini capsule. Note that wherever you set the WorkingDirectory variable to earlier, Agate will expect you to put your -Gemini capsule contents in a sub-folder called "content." So, I place my -files in "/var/gmi/content." I'm going to create that folder now and put -a file in there. +Gemini capsule contents in a sub-folder called "content." So, I place +my files in "/var/gmi/content." I'm going to create that folder now +and put a file in there. -#+begin_src sh +```sh sudo mkdir /var/gemini/content sudo nano /var/gemini/content/index.gmi -#+end_src +``` You can put whatever you want in the "index.gmi" file, just make sure it's valid Gemtext. -** The Results -:PROPERTIES: -:CUSTOM_ID: the-results -:END: +## The Results + Here are some screenshots of the Gemini page I just created in the -[[https://gmi.skyjake.fi/lagrange/][Lagrange]] browser and the -[[https://github.com/makeworld-the-better-one/amfora][amfora]] browser. +[Lagrange](https://gmi.skyjake.fi/lagrange/) browser and the +[amfora](https://github.com/makeworld-the-better-one/amfora) browser. -#+caption: GUI Gemini browser -[[https://img.cleberg.net/blog/20210417-hosting-a-gemini-server/lagrange.png]] + -/Lagrange/ +*Lagrange* -#+caption: CLI Gemini browser -[[https://img.cleberg.net/blog/20210417-hosting-a-gemini-server/amfora.png]] + -/Amfora/ +*Amfora* diff --git a/blog/2021-04-23-php-comment-system.org b/content/blog/2021-04-23-php-comment-system.md index d539a4e..21427ac 100644 --- a/blog/2021-04-23-php-comment-system.org +++ b/content/blog/2021-04-23-php-comment-system.md @@ -1,10 +1,11 @@ -#+title: Roll Your Own Static Commenting System in PHP -#+date: 2021-04-23 ++++ +date = 2021-04-23 +title = "Roll Your Own Static Commenting System in PHP" +description = "A simple guide to creating a commenting system in PHP." ++++ + +## The Terrible-ness of Commenting Systems -** The Terrible-ness of Commenting Systems -:PROPERTIES: -:CUSTOM_ID: the-terrible-ness-of-commenting-systems -:END: The current state of affairs regarding interactive comment systems is, well, terrible. It is especially awful if you're a privacy conscious person who does not generally load third-party scripts or frames on the @@ -15,26 +16,24 @@ something that should be standard. Of course, there are some really terrible options: -- Facebook Comments -- Discourse +- Facebook Comments +- Discourse There are some options that are better but still use too many scripts, frames, or social integrations on your web page that could impact some users: -- Disqus -- Isso -- Remark42 +- Disqus +- Isso +- Remark42 Lastly, I looked into a few unique ways of generating blog comments, such as using Twitter threads or GitHub issues to automatically post issues. However, these both rely on external third-party sites that I don't currently use. -** Stay Static with Server-Side Comments -:PROPERTIES: -:CUSTOM_ID: stay-static-with-server-side-comments -:END: +## Stay Static with Server-Side Comments + The main issue for my personal use-case is that my blog is completely, 100% static. I use PHP on the back-end but website visitors only see HTML and a single CSS file. No external javascript and no embedded @@ -42,14 +41,15 @@ frames. So, how do we keep a site static and still allow users to interact with blog posts? The key actually pretty simple - I'm already using PHP, so -why not rely on the classic HTML =<form>= and a PHP script to save the -comments somewhere? As it turns out, this was a perfect solution for me. +why not rely on the classic HTML `<form>` and a PHP script to +save the comments somewhere? As it turns out, this was a perfect +solution for me. The second issue for my personal use-case is that I am trying to keep the contents of my website accessible over time, as described by -[cite/t:@brandur], in his post entitled -[[https://brandur.org/fragments/graceful-degradation-time][Blog with -Markdown + Git, and degrade gracefully through time]] . +@brandur, in his post entitled [Blog with Markdown + Git, and degrade +gracefully through +time](https://brandur.org/fragments/graceful-degradation-time) . This means I cannot rely on a database for comments, since I do not rely on a database for any other part of my websites. @@ -59,37 +59,35 @@ that future readers will be able to see the source data long after I'm gone, or the website has gone offline. However, I still haven't committed any images served on my blog to Git, as I'm not entirely sold on Git LFS yet - for now, images can be found at -[[https://img.cleberg.net][img.cleberg.net]]. +[img.cleberg.net](https://img.cleberg.net). Saving my comments back to the Git repository ensures that another aspect of my site will degrade gracefully. -** Create a Comment Form -:PROPERTIES: -:CUSTOM_ID: create-a-comment-form -:END: +## Create a Comment Form + Okay, let's get started. The first step is to create an HTML form that users can see and utilize to submit comments. This is fairly easy and can be changed depending on your personal preferences. Take a look at the code block below for the form I currently use. Note -that =<current-url>= is replaced automatically in PHP with the current -post's URL, so that my PHP script used later will know which blog post -the comment is related to. +that `<current-url>` is replaced automatically in PHP with +the current post's URL, so that my PHP script used later will know +which blog post the comment is related to. The form contains the following structure: -1. =<form>= - This is the form and will determine which PHP script to - send the comment to. -2. =<section hidden>= - This section is hidden from the user and is used - to ensure that we know which blog post sent the comment. -3. =<section>= Display Name (Optional) - Used to accept a display name, - if entered. -4. =<section>= Comment (Required) - Used to accept the user's full - comment. Markdown is allowed. -5. =<button>= - A button to submit the form. - -#+begin_src html +1. `<form>` - This is the form and will determine which PHP + script to send the comment to. +2. `<section hidden>` - This section is hidden from the user + and is used to ensure that we know which blog post sent the comment. +3. `<section>` Display Name (Optional) - Used to accept a + display name, if entered. +4. `<section>` Comment (Required) - Used to accept the + user's full comment. Markdown is allowed. +5. `<button>` - A button to submit the form. + +```html <form action="/comment.php" method="POST"> <h3>Leave a Comment</h3> <section hidden> @@ -129,33 +127,32 @@ The form contains the following structure: </section> <button type="submit">Submit</button> </form> -#+end_src +``` + +## Handle Comments via POST -** Handle Comments via POST -:PROPERTIES: -:CUSTOM_ID: handle-comments-via-post -:END: Now that we have a form and can submit comments, we need to create a PHP script so that the server can fetch the comment data and save it. Make -sure your PHP script name matches the name you entered in the =action= -field in your form. - -See the code block below for the contents of my =comment.php= script. We -perform the following tasks in this script: - -1. Grab the POST data from the HTML form. -2. Sanitize the comment data with =htmlentities=. -3. Set the display name to =Anonymous= if it was left blank. -4. Create a PHP object that combines all of this data. -5. Check if our destination file =comments.json= exists. -6. If so, convert the PHP object to JSON and save it to the file. -7. If the =comments.json= file does not exist, the script will exit with - an error. You can alter this to ensure it creates the script, but my - source code includes the file by default, so it will always exist. -8. Finally, send the user back to the =#comments= section of the blog - post they just read. - -#+begin_src php +sure your PHP script name matches the name you entered in the +`action` field in your form. + +See the code block below for the contents of my `comment.php` +script. We perform the following tasks in this script: + +1. Grab the POST data from the HTML form. +2. Sanitize the comment data with `htmlentities`. +3. Set the display name to `Anonymous` if it was left blank. +4. Create a PHP object that combines all of this data. +5. Check if our destination file `comments.json` exists. +6. If so, convert the PHP object to JSON and save it to the file. +7. If the `comments.json` file does not exist, the script + will exit with an error. You can alter this to ensure it creates the + script, but my source code includes the file by default, so it will + always exist. +8. Finally, send the user back to the `#comments` section of + the blog post they just read. + +```php // Get the content sent from the comment form $comment = htmlentities($_POST['userContent']); $post_url = $_POST['postURL']; @@ -190,35 +187,33 @@ if (file_exists($file_name)) { // Send the user back header('Location: ' . $post_url . '#comments'); -#+end_src +``` -If you're using Apache, make sure the =www-data= user on your server has -the correct permissions to your website directory or else it will not be -able to write to =comments.json=. +If you're using Apache, make sure the `www-data` user on +your server has the correct permissions to your website directory or +else it will not be able to write to `comments.json`. -#+begin_src sh +```sh chgrp -R www-data /path/to/website/ chmod -R g+w comments.json -#+end_src +``` + +## Display User Comments -** Display User Comments -:PROPERTIES: -:CUSTOM_ID: display-user-comments -:END: Now that we can submit comments, and they are saved to the -=comments.json= file, let's make sure we can show those comments in each -blog post. +`comments.json` file, let's make sure we can show those +comments in each blog post. The code block below shows the function I use to decode my -=comments.json= file, check if the comments apply to the current post, -and then display them. +`comments.json` file, check if the comments apply to the +current post, and then display them. -This piece of code should *really* be inside a function (or at least in -an organized PHP workflow). Don't just copy-and-paste and expect it to -work. You need to at least supply a =$query= variable depending on the -page visited. +This piece of code should **really** be inside a function (or at least +in an organized PHP workflow). Don't just copy-and-paste and expect it +to work. You need to at least supply a `$query` variable +depending on the page visited. -#+begin_src php +```php $query = 'your-blog-post.html'; // Load saved comments @@ -250,35 +245,32 @@ foreach ($comments as $comment) { } echo $comment_section; -#+end_src +``` + +## Bonus: Create a 'Recent Comments' Page -** Bonus: Create a 'Recent Comments' Page -:PROPERTIES: -:CUSTOM_ID: bonus-create-a-recent-comments-page -:END: Finally, the last part of my current system is to create a Recent Comments page so that I can easily check-in on my blog and moderate any -spam. As an alternative, you could use PHP's =mail()= function to email -you for each blog comment. +spam. As an alternative, you could use PHP's `mail()` +function to email you for each blog comment. The code to do this is literally the same code as the previous section, I just make sure it is printed when someone visits -=https://example.com/comments/=. +`https://example.com/comments/`. + +## Possible Enhancements -** Possible Enhancements -:PROPERTIES: -:CUSTOM_ID: possible-enhancements -:END: This comment system is by no means a fully-developed system. I have noted a few possible enhancements here that I may implement in the future: -- Create a secure moderator page with user authentication at - =https://blog.example.com/mod/=. This page could have the option to - edit or delete any comment found in =comments.json=. -- Create a temporary file, such as =pending_comments.json=, that will - store newly-submitted comments and won't display on blog posts until - approved by a moderator. -- Create a =/modlog/= page with a chronological log, showing which - moderator approved which comments and why certain comments were - rejected. +- Create a secure moderator page with user authentication at + `https://blog.example.com/mod/`. This page could have the + option to edit or delete any comment found in + `comments.json`. +- Create a temporary file, such as `pending_comments.json`, + that will store newly-submitted comments and won't display on blog + posts until approved by a moderator. +- Create a `/modlog/` page with a chronological log, + showing which moderator approved which comments and why certain + comments were rejected. diff --git a/blog/2021-04-28-photography.org b/content/blog/2021-04-28-photography.md index 6e2627d..a800ecd 100644 --- a/blog/2021-04-28-photography.org +++ b/content/blog/2021-04-28-photography.md @@ -1,71 +1,68 @@ -#+title: Jumping Back Into Photography -#+date: 2021-04-28 ++++ +date = 2021-04-28 +title = "Jumping Back Into Photography" +description = "Some thoughts on photography." ++++ -** Why Photography? -:PROPERTIES: -:CUSTOM_ID: why-photography -:END: -I've often wondered why photography is as enticing as it is. You can see -billions of people around the world taking photographs every single +## Why Photography? + +I've often wondered why photography is as enticing as it is. You can +see billions of people around the world taking photographs every single moment of the day. New technology often boasts about their photographic capabilities, especially smartphones. I would even assume that we live in a world where there is never a moment in which a photograph is not being taken somewhere on Earth. As for myself, I would simply say that I enjoy preserving a memory in -physical (or digital) form. I've never had the best memory when it comes -to recalling details of places and people gone by, so it helps to have a -frame of reference lying around. +physical (or digital) form. I've never had the best memory when it +comes to recalling details of places and people gone by, so it helps to +have a frame of reference lying around. Regardless of the reason, I think most people would agree that you simply cannot have too many hobbies. -** Older Cameras -:PROPERTIES: -:CUSTOM_ID: older-cameras -:END: +## Older Cameras + I started playing around with the idea of photography when my family purchased a Fujifilm camera for family-specific events. I don't recall the specific model, but I do recall it was a point-and-shoot camera without an interchangeable lens. However, it was of great value to -someone, like myself, who couldn't afford any other camera. I took about -10,000 shots with that camera over a 3-5 year span. Most notably, all of -my trips to California were documented through this camera. +someone, like myself, who couldn't afford any other camera. I took +about 10,000 shots with that camera over a 3-5 year span. Most notably, +all of my trips to California were documented through this camera. When possible, I would borrow my sister's camera, which is a Sony SLT-A58. This camera was great and allowed for some of my best early shots, especially those taken in Utah's and Nevada's parks. -** My Current Kit -:PROPERTIES: -:CUSTOM_ID: my-current-kit -:END: +## My Current Kit + I've finally come to a point in my life where I have the disposable income to invest in a solid photography kit. I played around with the idea of a lot of different cameras, different types, new vs used, etc. -Finally, I settled on the -[[https://en.wikipedia.org/wiki/Sony_%CE%B17_III][Sony α7 III]]. This -camera is mirror-less and uses a full-frame image sensor at 24 -megapixels. I don't create large prints, and I am mostly focused on -preserving memories in high quality for the next 5-10 years with this -camera, so the specifications here are just perfect for me. +Finally, I settled on the [Sony α7 +III](https://en.wikipedia.org/wiki/Sony_%CE%B17_III). This camera is +mirror-less and uses a full-frame image sensor at 24 megapixels. I +don't create large prints, and I am mostly focused on preserving +memories in high quality for the next 5-10 years with this camera, so +the specifications here are just perfect for me. For lenses, I decided to buy two lenses that could carry me through most situations: -- [[https://electronics.sony.com/imaging/lenses/full-frame-e-mount/p/sel2470z][Vario-Tessar - T* FE 24-70 mm F4 ZA OSS]] -- [[https://www.tamron-usa.com/product/lenses/a047.html][Tamron 70-300mm - f4.5-6.3 Di III RXD]] +- [Vario-Tessar T\* FE 24-70 mm F4 ZA + OSS](https://electronics.sony.com/imaging/lenses/full-frame-e-mount/p/sel2470z) +- [Tamron 70-300mm f4.5-6.3 Di III + RXD](https://www.tamron-usa.com/product/lenses/a047.html) -In addition, I grabbed a couple -[[https://www.promaster.com/Product/6725][HGX Prime 67mm]] protection -filters for the lenses. +In addition, I grabbed a couple [HGX Prime +67mm](https://www.promaster.com/Product/6725) protection filters for the +lenses. As I delve further into photography and pick up more skills, I will most likely go back and grab a lens with a higher f-stop value, such as -f/1.8. I toyed with the idea of grabbing a 50 mm at =f/1.8=, but decided -to keep things in a reasonable price range instead. +f/1.8. I toyed with the idea of grabbing a 50 mm at `f/1.8`, +but decided to keep things in a reasonable price range instead. Finally, I made sure to buy a photography-specific backpack with a rain guard, and the zipper on the back panel, to protect the equipment while diff --git a/blog/2021-05-30-changing-git-authors.org b/content/blog/2021-05-30-changing-git-authors.md index a41f5f3..d47d85f 100644 --- a/blog/2021-05-30-changing-git-authors.org +++ b/content/blog/2021-05-30-changing-git-authors.md @@ -1,10 +1,11 @@ -#+title: Changing Git Authors -#+date: 2021-05-30 ++++ +date = 2021-05-30 +title = "Changing Git Authors" +description = "A guide to change Git author names and emails in old commits." ++++ + +## Changing Git Author/Email Based on Previously Committed Email -** Changing Git Author/Email Based on Previously Committed Email -:PROPERTIES: -:CUSTOM_ID: changing-git-authoremail-based-on-previously-committed-email -:END: Here's the dilemma: You've been committing changes to your git repository with an incorrect name or email (or multiple repositories), and now you want to fix it. Luckily, there's a semi-reliable way to fix @@ -14,18 +15,18 @@ of commits, so use this method only if you're okay accepting that risk. Okay, let's create the bash script: -#+begin_src sh +```sh nano change_git_authors.sh -#+end_src +``` The following information can be pasted directly into your bash script. The only changes you need to make are to the following variables: -- =OLD_EMAIL= -- =CORRECT_NAME= -- =CORRECT_EMAIL= +- `OLD_EMAIL` +- `CORRECT_NAME` +- `CORRECT_EMAIL` -#+begin_src sh +```sh #!/bin/sh # List all sub-directories in the current directory @@ -58,16 +59,16 @@ do cd .. done -#+end_src +``` Finally, save the bash script and make it executable. -#+begin_src sh +```sh chmod a+x change_git_authors.sh -#+end_src +``` Now you can run the script and should see the process begin. -#+begin_src sh +```sh ./change_git_authors.sh -#+end_src +``` diff --git a/blog/2021-07-15-delete-gitlab-repos.org b/content/blog/2021-07-15-delete-gitlab-repos.md index 99249e9..fbcfee9 100644 --- a/blog/2021-07-15-delete-gitlab-repos.org +++ b/content/blog/2021-07-15-delete-gitlab-repos.md @@ -1,10 +1,11 @@ -#+title: How to Delete All GitLab Repositories -#+date: 2021-07-15 ++++ +date = 2021-07-15 +title = "How to Delete All GitLab Repositories" +description = "Learn how to delete all GitLab repositories in your account." ++++ + +## Background -** Background -:PROPERTIES: -:CUSTOM_ID: background -:END: Have you ever used GitLab to host your source code, moved to a different host, and wanted to delete everything from your GitLab account? Well, this post covers any scenario where you would want to delete all @@ -15,43 +16,37 @@ manually delete them whenever I switch host. GitHub has a few different tools online to delete all repositories for you, but I have not found anything similar for GitLab, so I needed an alternative solution. -** Use a Python Script -:PROPERTIES: -:CUSTOM_ID: use-a-python-script -:END: -*** Requirements -:PROPERTIES: -:CUSTOM_ID: requirements -:END: +## Use a Python Script + +### Requirements + Before we look at the script, make sure you know your GitLab username. -Next, [[https://gitlab.com/-/profile/personal_access_tokens][create an -authorization token]] so that the Python script can delete your -repositories. Don't lose this token or else you'll need to create a new -one. - -*** Create the Script -:PROPERTIES: -:CUSTOM_ID: create-the-script -:END: +Next, [create an authorization +token](https://gitlab.com/-/profile/personal_access_tokens) so that the +Python script can delete your repositories. Don't lose this token or +else you'll need to create a new one. + +### Create the Script + To run a Python script, you must first create it. Open a terminal and enter the following commands in whichever directory you prefer to store the script. You can do the same things in a file manager if you prefer. -#+begin_src sh +```sh mkdir delete-gitlab -#+end_src +``` -#+begin_src sh +```sh cd delete-gitlab -#+end_src +``` -#+begin_src sh +```sh nano main.py -#+end_src +``` -Enter the following code into your =main.py= script. +Enter the following code into your `main.py` script. -#+begin_src python +```python import request import json @@ -105,16 +100,16 @@ def main(): if __name__ == "__main__": main() -#+end_src +``` -Now that you have the proper information, replace ={user-id}= with your -GitLab username and ={auth-token}= with the authorization token you -created earlier. +Now that you have the proper information, replace `{user-id}` +with your GitLab username and `{auth-token}` with the +authorization token you created earlier. Finally, simply run the script and watch the output. You can also use -PyCharm Community Edition to edit and run the Python script if you don't -want to work in a terminal. +PyCharm Community Edition to edit and run the Python script if you +don't want to work in a terminal. -#+begin_src sh +```sh python3 main.py -#+end_src +``` diff --git a/blog/2021-08-25-audit-sampling.org b/content/blog/2021-08-25-audit-sampling.md index ac6f157..f31f276 100644 --- a/blog/2021-08-25-audit-sampling.org +++ b/content/blog/2021-08-25-audit-sampling.md @@ -1,10 +1,11 @@ -#+title: Audit Sampling with Python -#+date: 2021-08-25 ++++ +date = 2021-08-25 +title = "Audit Sampling with Python" +description = "Learn how to sample populations with Python." ++++ + +## Introduction -** Introduction -:PROPERTIES: -:CUSTOM_ID: introduction -:END: For anyone who is familiar with internal auditing, external auditing, or consulting, you will understand how tedious audit testing can become when you are required to test large swaths of data. When we cannot @@ -18,38 +19,34 @@ quite a lot of people. While some audit-focused tools have introduced sampling functionality (e.g. Wdesk), many audit departments and firms cannot use software like this due to certain constraints, such as the team's budget or knowledge. Here is where this article comes in: we're -going to use [[https://www.python.org][Python]], a free and open-source +going to use [Python](https://www.python.org), a free and open-source programming language, to generate random samples from a dataset in order to suffice numerous audit situations. -** Audit Requirements for Sampling -:PROPERTIES: -:CUSTOM_ID: audit-requirements-for-sampling -:END: +## Audit Requirements for Sampling + Before we get into the details of how to sample with Python, I want to make sure I discuss the different requirements that auditors may have of samples used within their projects. -*** Randomness -:PROPERTIES: -:CUSTOM_ID: randomness -:END: -First, let's discuss randomness. When testing out new technology to help -assist with audit sampling, you need to understand exactly how your +### Randomness + +First, let's discuss randomness. When testing out new technology to +help assist with audit sampling, you need to understand exactly how your samples are being generated. For example, if the underlying function is just picking every 57th element from a list, that's not truly random; it's a systematic form of sampling. Luckily, since Python is open-source, we have access to its codebase. Through this blog post, I -will be using the [[https://pandas.pydata.org][pandas]] module in order -to generate the random samples. More specifically, I will be using the -[[https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.sample.html][pandas.DataFrame.sample]] +will be using the [pandas](https://pandas.pydata.org) module in order to +generate the random samples. More specifically, I will be using the +[pandas.DataFrame.sample](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.sample.html) function provided by Pandas. Now that you know what you're using, you can always check out the code -behind =pandas.DataFrame.sample=. This function does a lot of work, but -we really only care about the following snippets of code: +behind `pandas.DataFrame.sample`. This function does a lot of +work, but we really only care about the following snippets of code: -#+begin_src python +```python # Process random_state argument rs = com.random_state(random_state) @@ -61,25 +58,24 @@ if ignore_index: result.index = ibase.default_index(len(result)) return result -#+end_src - -The block of code above shows you that if you assign a =random_state= -argument when you run the function, that will be used as a seed number -in the random generation and will allow you to reproduce a sample, given -that nothing else changes. This is critical to the posterity of audit -work. After all, how can you say your audit process is adequately -documented if the next person can't run the code and get the same -sample? The final piece here on randomness is to look at the -[[https://docs.%20python.org/3/library/random.html#random.choice][choice]] +``` + +The block of code above shows you that if you assign a +`random_state` argument when you run the function, that will +be used as a seed number in the random generation and will allow you to +reproduce a sample, given that nothing else changes. This is critical to +the posterity of audit work. After all, how can you say your audit +process is adequately documented if the next person can't run the code +and get the same sample? The final piece here on randomness is to look +at the +[choice](https://docs.%20python.org/3/library/random.html#random.choice) function used above. This is the crux of the generation and can also be examined for more detailed analysis on its reliability. As far as auditing goes, we will trust that these functions are mathematically random. -*** Sample Sizes -:PROPERTIES: -:CUSTOM_ID: sample-sizes -:END: +### Sample Sizes + As mentioned in the intro, sampling is only an effective method of auditing when it truly represents the entire population. While some audit departments or firms may consider certain judgmental sample sizes @@ -98,38 +94,35 @@ proprietary, table that will instruct auditors which sample sizes to choose. This allows for uniform testing and reduces overall workload. See the table below for a common implementation of sample sizes: -| Control Frequency | Sample Size - High Risk | Sample Size - Low Risk | -|-------------------+-------------------------+------------------------| -| More Than Daily | 40 | 25 | -| Daily | 40 | 25 | -| Weekly | 12 | 5 | -| Monthly | 5 | 3 | -| Quarterly | 2 | 2 | -| Semi-Annually | 1 | 1 | -| Annually | 1 | 1 | -| Ad-hoc | 1 | 1 | - -** Sampling with Python & Pandas -:PROPERTIES: -:CUSTOM_ID: sampling-with-python-pandas -:END: + Control Frequency Sample Size - High Risk Sample Size - Low Risk + ------------------- ------------------------- ------------------------ + More Than Daily 40 25 + Daily 40 25 + Weekly 12 5 + Monthly 5 3 + Quarterly 2 2 + Semi-Annually 1 1 + Annually 1 1 + Ad-hoc 1 1 + +## Sampling with Python & Pandas + In this section, I am going to cover a few basic audit situations that require sampling. While some situations may require more effort, the syntax, organization, and intellect used remain largely the same. If -you've never used Python before, note that lines starting with a '=#=' -symbol are called comments, and they will be skipped by Python. I highly -recommend taking a quick tutorial online to understand the basics of -Python if any of the code below is confusing to you. - -*** Simple Random Sample -:PROPERTIES: -:CUSTOM_ID: simple-random-sample -:END: +you've never used Python before, note that lines starting with a +'`#`' symbol are called comments, and they will be skipped +by Python. I highly recommend taking a quick tutorial online to +understand the basics of Python if any of the code below is confusing to +you. + +### Simple Random Sample + First, let's look at a simple, random sample. The code block below will -import the =pandas= module, load a data file, sample the data, and -export the sample to a file. +import the `pandas` module, load a data file, sample the +data, and export the sample to a file. -#+begin_src python +```python # Import the Pandas module import pandas @@ -147,16 +140,14 @@ sample = df.sample(n=25, random_state=0) # Save the sample to Excel sample.to_excel(file_output) -#+end_src +``` + +### Simple Random Sample: Using Multiple Input Files -*** Simple Random Sample: Using Multiple Input Files -:PROPERTIES: -:CUSTOM_ID: simple-random-sample-using-multiple-input-files -:END: Now that we've created a simple sample, let's create a sample from multiple files. -#+begin_src python +```python # Import the Pandas module import pandas @@ -183,17 +174,15 @@ sample = pandas.concat([sample_01, sample_02, sample_03], ignore_index=True) # Save the sample to Excel sample.to_excel(file_output) -#+end_src +``` + +### Stratified Random Sample -*** Stratified Random Sample -:PROPERTIES: -:CUSTOM_ID: stratified-random-sample -:END: Well, what if you need to sample distinct parts of a single file? For example, let's write some code to separate our data by "Region" and sample those regions independently. -#+begin_src python +```python # Import the Pandas module import pandas @@ -219,18 +208,16 @@ sample = pandas.concat([sample_east, sample_west], ignore_index=True) # Save the sample to Excel sample.to_excel(file_output) -#+end_src +``` + +### Stratified Systematic Sample -*** Stratified Systematic Sample -:PROPERTIES: -:CUSTOM_ID: stratified-systematic-sample -:END: This next example is quite useful if you need audit coverage over a certain time period. This code will generate samples for each month in the data and combine them all together at the end. Obviously, this code can be modified to stratify by something other than months, if needed. -#+begin_src python +```python # Import the Pandas module import pandas @@ -270,23 +257,21 @@ def monthly_stratified_sample(df: pandas.DataFrame, date_column: str, num_select sample_size = 3 sample = monthly_stratified_sample(df, 'Date of Sale', sample_size) sample.to_excel(file_output) -#+end_src - -** Documenting the Results -:PROPERTIES: -:CUSTOM_ID: documenting-the-results -:END: -Once you've generated a proper sample, there are a few things left to do -in order to properly ensure your process is reproducible. - -1. Document the sample. Make sure the resulting file is readable and - includes the documentation listed in the next bullet. -2. Include documentation around the data source, extraction techniques, - any modifications made to the data, and be sure to include a copy of - the script itself. -3. Whenever possible, perform a completeness and accuracy test to ensure - your sample is coming from a complete and accurate population. To - ensure completeness, compare the record count from the data source to - the record count loaded into Python. To ensure accuracy, test a small - sample against the source data (e.g., test 5 sales against the - database to see if the details are accurate). +``` + +## Documenting the Results + +Once you've generated a proper sample, there are a few things left to +do in order to properly ensure your process is reproducible. + +1. Document the sample. Make sure the resulting file is readable and + includes the documentation listed in the next bullet. +2. Include documentation around the data source, extraction techniques, + any modifications made to the data, and be sure to include a copy of + the script itself. +3. Whenever possible, perform a completeness and accuracy test to + ensure your sample is coming from a complete and accurate + population. To ensure completeness, compare the record count from + the data source to the record count loaded into Python. To ensure + accuracy, test a small sample against the source data (e.g., test 5 + sales against the database to see if the details are accurate). diff --git a/content/blog/2021-10-09-apache-redirect.md b/content/blog/2021-10-09-apache-redirect.md new file mode 100644 index 0000000..e66f5b3 --- /dev/null +++ b/content/blog/2021-10-09-apache-redirect.md @@ -0,0 +1,46 @@ ++++ +date = 2021-10-09 +title = "Apache Redirect HTML Files to a Directory" +description = "A guide on redirecting HTML files to directory in Apache." ++++ + +## The Problem + +After recently switching static site generators (SSG), my blog URLs +changed with no option to preserve the classic `.html` +extension at the end of my blog post URLs. + +I really disliked using my old SSG ([Jekyll](https://jekyllrb.com)) and +prefer my new tool ([Zola](https://www.getzola.org)) much more, so I was +determined to figure out a way to get the proper redirect set up so that +people who find my posts online aren't constantly met by 404 errors. + +## The Solution + +To solve this problem, I really needed to solve two pieces: + +1. Redirect all blog post URL requests from + `/blog/some-post.html` to `/blog/some-post/`. +2. Ensure that no other `.html` files are redirected, such + as `index.html`. + +After *a lot* of tweaking and testing, I believe I have finally found +the solution. The solution is shown below. + +```conf +RewriteEngine On +RewriteCond %{REQUEST_URI} !\index.html$ [NC] +RewriteRule ^(.*).html$ https://example.com/$1 [R=301,L] +``` + +This piece of code in the Apache `.conf` or +`.htaccess` file will do the following: + +1. Turn on the RewriteEngine so that we can modify URLs. +2. Ignore any `index.html` files from the rule we are about + to specify. +3. Find any `.html` files within the website directory and + redirect it to exclude the file extension. +4. The final piece is adding the trailing slash (`/`) at the + end of the URL - you'll notice that I don't have an Apache rule + for that since Apache handles that automatically. diff --git a/blog/2021-12-04-cisa.org b/content/blog/2021-12-04-cisa.md index 7b70b80..42b9d79 100644 --- a/blog/2021-12-04-cisa.org +++ b/content/blog/2021-12-04-cisa.md @@ -1,19 +1,21 @@ -#+title: I Passed the CISA! -#+date: 2021-12-04 ++++ +date = 2021-12-04 +title = "I Passed the CISA!" +description = "A recap of the CISA certification exam and my results." ++++ + +## What is the CISA? -** What is the CISA? -:PROPERTIES: -:CUSTOM_ID: what-is-the-cisa -:END: For those of you lucky enough not to be knee-deep in the world of IT/IS -Auditing, [[https://www.isaca.org/credentialing/cisa][CISA]] stands for +Auditing, [CISA](https://www.isaca.org/credentialing/cisa) stands for Certified Information Systems Auditor. This certification and exam are -part of ISACA's suite of certifications. As I often explain it to people -like my family, it basically means you're employed to use your knowledge -of information systems, regulations, common threats, risks, etc. in -order to assess an organization's current control of their risk. If a -risk isn't controlled (and the company doesn't want to accept the risk), -an IS auditor will suggest implementing a control to address that risk. +part of ISACA's suite of certifications. As I often explain it to +people like my family, it basically means you're employed to use your +knowledge of information systems, regulations, common threats, risks, +etc. in order to assess an organization's current control of their +risk. If a risk isn't controlled (and the company doesn't want to +accept the risk), an IS auditor will suggest implementing a control to +address that risk. Now, the CISA certification itself is, in my opinion, the main certification for this career. While certifications such as the CPA or @@ -25,13 +27,13 @@ However, to be honest, I am a skeptic of most certifications. I understand the value they hold in terms of how much you need to commit to studying or learning on the job, as well as the market value for certifications such as the CISA. But I also have known some very -+incompetent+ /less than stellar/ auditors who have CPAs, CISAs, CIAs, +~~incompetent~~ *less than stellar* auditors who have CPAs, CISAs, CIAs, etc. The same goes for most industries: if a person is good at studying, they can earn the certification. However, that knowledge means nothing unless -you're actually able to use it in real life and perform as expected of a -certification holder. The challenge comes when people are hired or +you're actually able to use it in real life and perform as expected of +a certification holder. The challenge comes when people are hired or connected strictly because of their certifications or resume; you need to see a person work before you can assume them having a CISA means they're better than someone without the CISA. @@ -40,56 +42,50 @@ Okay, rant over. Certifications are generally accepted as a measuring stick of commitment and quality of an employee, so I am accepting it too. -** Exam Content -:PROPERTIES: -:CUSTOM_ID: exam-content -:END: +## Exam Content + The CISA is broken down into five sections, each weighted with a percentage of test questions that may appear. -#+caption: CISA exam sections -[[https://img.cleberg.net/blog/20211204-i-passed-the-cisa/cisa-exam-sections.png]] + Since the exam contains 150 questions, here's how those sections break down: -| Exam Section | Percentage of Exam | Questions | -|---------------+--------------------+-----------| -| 1 | 21% | 32 | -| 2 | 17% | 26 | -| 3 | 12% | 18 | -| 4 | 23% | 34 | -| 5 | 27% | 40 | -| *Grand Total* | *100%* | *150* | - -** My Studying Habits -:PROPERTIES: -:CUSTOM_ID: my-studying-habits -:END: + Exam Section Percentage of Exam Questions + ----------------- -------------------- ----------- + 1 21% 32 + 2 17% 26 + 3 12% 18 + 4 23% 34 + 5 27% 40 + **Grand Total** **100%** **150** + +## My Studying Habits + This part is a little hard for me to break down into specific detail due to the craziness of the last year. While I officially purchased my -studying materials in December 2020 and opened them to "start studying" -in January 2021, I really wasn't able to study much due to the demands -of my job and personal life. +studying materials in December 2020 and opened them to "start +studying" in January 2021, I really wasn't able to study much due to +the demands of my job and personal life. Let me approach this from a few different viewpoints. -*** Study Materials -:PROPERTIES: -:CUSTOM_ID: study-materials -:END: +### Study Materials + Let's start by discussing the study materials I purchased. I'll be referring to #1 as the CRM and #2 as the QAE. -1. [[https://store.isaca.org/s/store#/store/browse/detail/a2S4w000004KoCbEAK][CISA - Review Manual, 27th Edition | Print]] -2. [[https://store.isaca.org/s/store#/store/browse/detail/a2S4w000004KoCcEAK][CISA - Review Questions, Answers & Explanations Manual, 12th Edition | - Print]] +1. [CISA Review Manual, 27th Edition \| + Print](https://store.isaca.org/s/store#/store/browse/detail/a2S4w000004KoCbEAK) +2. [[<https://store.isaca.org/s/store#/store/browse/detail/a2S4w000004KoCcEAK>][CISA + Review Questions, Answers & Explanations Manual, 12th Edition \| + Print]] The CRM is an excellent source of information and could honestly be used as a reference for most IS auditors as a learning reference during their -daily audit responsibilities. However, it is *full* of information and +daily audit responsibilities. However, it is **full** of information and can be overloading if you're not good at filtering out useless information while studying. @@ -99,10 +95,10 @@ complaint about the QAE is that each question is immediately followed with the correct answer and explanations below it, which means I had to use something to constantly cover the answers while I was studying. -I didn't use the online database version of the QAE, but I've heard that -it's easier to use than the printed book. However, it is more expensive -($299 database vs $129 book) which might be important if you're paying -for materials yourself. +I didn't use the online database version of the QAE, but I've heard +that it's easier to use than the printed book. However, it is more +expensive (\$299 database vs \$129 book) which might be important if +you're paying for materials yourself. In terms of question difficulty, I felt that the QAE was a good representation of the actual exam. I've seen a lot of people online say @@ -115,10 +111,8 @@ topics you struggle with), and use the QAE to continue practicing exam-like questions, you should be fine. I didn't use any online courses, videos, etc. - the ISACA materials are more than enough. -*** Studying Process -:PROPERTIES: -:CUSTOM_ID: studying-process -:END: +### Studying Process + While I was able to briefly read through sections 1 and 2 in early 2021, I had to stop and take a break from February/March to September. I switched jobs in September, which allowed me a lot more free time to @@ -130,62 +124,60 @@ practice exam from the QAE manual and scored 70% (105/150). Here's a breakdown of my initial practice exam: -| Exam Section | Incorrect | Correct | Grand Total | Percent | -|---------------+-----------+---------+-------------+---------| -| 1 | 8 | 25 | 33 | 76% | -| 2 | 5 | 20 | 25 | 80% | -| 3 | 6 | 12 | 18 | 67% | -| 4 | 10 | 23 | 33 | 70% | -| 5 | 16 | 25 | 41 | 61% | -| *Grand Total* | *45* | *105* | *150* | *70%* | + Exam Section Incorrect Correct Grand Total Percent + ----------------- ----------- --------- ------------- --------- + 1 8 25 33 76% + 2 5 20 25 80% + 3 6 12 18 67% + 4 10 23 33 70% + 5 16 25 41 61% + **Grand Total** **45** **105** **150** **70%** As I expected, my toughest sections were related to project management, development, implementation, and security. This just leaves October and November. For these months, I tried to practice every few days, doing 10 questions for each section, until the -exam. This came out to 13 practice sessions, ~140 questions per section, -and ~700 questions total. +exam. This came out to 13 practice sessions, \~140 questions per +section, and \~700 questions total. While some practice sessions were worse and some were better, the final results were similar to my practice exam results. As you can see below, my averages were slightly worse than my practice exam. However, I got in -over 700 questions of practice and, most importantly, *I read through +over 700 questions of practice and, most importantly, \*I read through the explanations every time I answered incorrectly and learned from my -mistakes*. - -| Exam Section | Incorrect | Correct | Grand Total | Percent | -|---------------+-----------+---------+-------------+---------| -| 1 | 33 | 108 | 141 | 77% | -| 2 | 33 | 109 | 142 | 77% | -| 3 | 55 | 89 | 144 | 62% | -| 4 | 52 | 88 | 140 | 63% | -| 5 | 55 | 85 | 140 | 61% | -| *Grand Total* | *228* | *479* | *707* | *68%* | - -#+caption: CISA practice question results -[[https://img.cleberg.net/blog/20211204-i-passed-the-cisa/cisa-practice-questions-results.png]] - -** Results -:PROPERTIES: -:CUSTOM_ID: results -:END: +mistakes\*. + + Exam Section Incorrect Correct Grand Total Percent + ----------------- ----------- --------- ------------- --------- + 1 33 108 141 77% + 2 33 109 142 77% + 3 55 89 144 62% + 4 52 88 140 63% + 5 55 85 140 61% + **Grand Total** **228** **479** **707** **68%** + + + +## Results + Now, how do the practice scores reflect my actual results? After all, it's hard to tell how good a practice regimen is unless you see how it turns out. -| Exam Section | Section Name | Score | -|--------------+------------------------------------------------------------------+-------| -| 1 | Information Systems Auditing Process | 678 | -| 2 | Governance and Management of IT | 590 | -| 3 | Information Systems Acquisition, Development, and Implementation | 721 | -| 4 | Information Systems Operations and Business Resilience | 643 | -| 5 | Protection of Information Assets | 511 | -| *TOTAL* | | *616* | + Exam Section Section Name Score + -------------- ------------------------------------------------------------------ --------- + 1 Information Systems Auditing Process 678 + 2 Governance and Management of IT 590 + 3 Information Systems Acquisition, Development, and Implementation 721 + 4 Information Systems Operations and Business Resilience 643 + 5 Protection of Information Assets 511 + **TOTAL** **616** Now, in order to pass the CISA, you need at least 450 on a sliding scale of 200-800. Personally, I really have no clue what an average CISA score -is. After a /very/ brief look online, I can see that the high end is +is. After a *very* brief look online, I can see that the high end is usually in the low 700s. In addition, only about 50-60% of people pass the exam. @@ -204,10 +196,8 @@ CISA topics at all, the most important part of studying is doing practice questions. You really need to understand how to read the questions critically and pick the best answer. -** Looking Forward -:PROPERTIES: -:CUSTOM_ID: looking-forward -:END: +## Looking Forward + I am extremely happy that I was finally able to pass the CISA. Looking to the future, I'm not sure what's next in terms of professional learning. My current company offers internal learning courses, so I will diff --git a/blog/2022-02-10-leaving-the-office.org b/content/blog/2022-02-10-leaving-the-office.md index df5fc33..e9e45a7 100644 --- a/blog/2022-02-10-leaving-the-office.org +++ b/content/blog/2022-02-10-leaving-the-office.md @@ -1,10 +1,11 @@ -#+title: Leaving Office-Based Work In the Past -#+date: 2022-02-10 ++++ +date = 2022-02-10 +title = "Leaving Office-Based Work in the Past" +description = "My thoughts on the current surge of remote work and what that means for full-time office-based roles." ++++ + +## The Working World is Changing -** The Working World is Changing -:PROPERTIES: -:CUSTOM_ID: the-working-world-is-changing -:END: There has been a trend for the past few years of companies slowly realizing that the pandemic is not just a temporary state that will go away eventually and let everything return to the way it was before. In @@ -22,14 +23,10 @@ I decided to take a look back at my relatively short career so far and compare the positive and negative effects of the different work environments I've been in. -** In-Person Offices -:PROPERTIES: -:CUSTOM_ID: in-person-offices -:END: -*** Retail Internship -:PROPERTIES: -:CUSTOM_ID: retail-internship -:END: +## In-Person Offices + +### Retail Internship + I started my first job as a management intern at a busy retail pharmacy, working my 40-hour weeks on my feet. As these retail stores don't believe in resting or sitting down, you can guarantee that you will @@ -45,12 +42,10 @@ However, if you are able to operate a retail store with a limited crew and provide enough comfort and support, I believe these jobs could be both comfortable and efficient. -*** Semi-Private Cubicles -:PROPERTIES: -:CUSTOM_ID: semi-private-cubicles -:END: -#+caption: Semi-Private Cubicles -[[https://img.cleberg.net/blog/20220210-leaving-office-based-work-in-the-past/private_cubicles.png]] +### Semi-Private Cubicles + + After about a year, I was able to find another internship - this time, it was in my field of interest: internal auditing. This was for a life @@ -65,8 +60,8 @@ formed into cubicles that house 4 desks/employees. These "pods" of 4-person cubicles are linked throughout each floor of the headquarters (except the sales people, who had that open-floor concept going on). The walls of the cubicle were tall and provided a lot of privacy and -sound-proofing, except when I used the standing desk feature (I'm over 6 -feet tall, so probably not an issue for most people). +sound-proofing, except when I used the standing desk feature (I'm over +6 feet tall, so probably not an issue for most people). I loved this environment, it allowed me to focus on my work with minimal distractions, but also allowed easy access, so I could spin around in my @@ -74,12 +69,10 @@ chair and chat with my friends without leaving my chair. This is the closest I've been to a home office environment (which is my personal favorite, as I'll get to later in this post). -*** Semi-Open Floor Concept -:PROPERTIES: -:CUSTOM_ID: semi-open-floor-concept -:END: -#+caption: Semi-Open Floor Concept -[[https://img.cleberg.net/blog/20220210-leaving-office-based-work-in-the-past/semi_open_office.png]] +### Semi-Open Floor Concept + + When I shifted to my first full-time internal audit job out of college, I was working at a company that was headquartered on a floor in a @@ -87,8 +80,8 @@ downtown high-rise building. The company was only about 20 years old when I worked there and were trying a lot of new things to attract young talent, one of which was a semi-open floor concept for the office. My department worked just around the hallway corner from the executive -offices and used that "modern" layout young tech companies started using -in the 2000s/2010s. +offices and used that "modern" layout young tech companies started +using in the 2000s/2010s. Each desk was brief, and you could look most coworkers in the face without moving from your chair, I hated this so much. Directly to my @@ -104,18 +97,17 @@ conversation would be constant throughout the day while you try to work. For someone like me, who needs silence to get work done, that was a non-starter. -*** Hotel Office Concept -:PROPERTIES: -:CUSTOM_ID: hotel-office-concept -:END: -#+caption: Hotel Office Concept -[[https://img.cleberg.net/blog/20220210-leaving-office-based-work-in-the-past/hotel_desks.png]] +### Hotel Office Concept + + I currently work for a company remotely (for now) and travel to the office every once in a while for events and to help coach the staff underneath me. The office I visit uses the hotel desk concept, where you -need to check in at a touch screen when you enter the office and "rent" -a desk for the day. The same goes for offices and meeting rooms. +need to check in at a touch screen when you enter the office and +"rent" a desk for the day. The same goes for offices and meeting +rooms. These desks are flat-top only and do not have any walls at all. In addition, they're stacked with one row of 4 desks facing another row of @@ -133,12 +125,10 @@ Luckily, you can rent offices with doors that offer quiet and privacy, which can be very nice if you have a lot of meetings or webinars on a certain day. -** Home Office -:PROPERTIES: -:CUSTOM_ID: home-office -:END: -#+caption: Home Office -[[https://img.cleberg.net/blog/20220210-leaving-office-based-work-in-the-past/home_office.png]] +## Home Office + + Okay, now let's finally get to the home office concept. I have worked from home for a little over two years at this point, across three @@ -150,16 +140,11 @@ These things might not apply to you, and that's fine. Everyone has a different situation, and I really don't think you'll know what works until you try. -*** Tip #1 -:PROPERTIES: -:CUSTOM_ID: tip-1 -:END: -Let's start with my top rule for a home office: +### Tip #1 -#+begin_quote -If you live with others, working in a shared space is not effective. +Let's start with my top rule for a home office: -#+end_quote +> If you live with others, working in a shared space is not effective. It just does not work. If you have another person sleeping in your bedroom, it is difficult to manage your work schedule with their @@ -172,17 +157,12 @@ likely won't work either. Distractions will come far more frequently: televisions, cooking, cleaning, deliveries, etc. If you're like me, you'll end up playing a game instead of actually doing any work. -*** Tip #2 -:PROPERTIES: -:CUSTOM_ID: tip-2 -:END: -Okay, the second thing I've discovered that works for me: +### Tip #2 -#+begin_quote -Use the pomodoro method (or something similar) to balance work tasks -with personal tasks. +Okay, the second thing I've discovered that works for me: -#+end_quote +> Use the pomodoro method (or something similar) to balance work tasks +> with personal tasks. I use a very casual version of the pomodoro method where I will work for 1-2 hours (usually set in strict intervals like 1, 1.5, 2 hours) and @@ -196,18 +176,13 @@ clothes in the washer, get the mail, etc. If you're in a convenient location, this usually gives time for things like getting groceries (as long as you're not a slow shopper). -*** Tip #3 -:PROPERTIES: -:CUSTOM_ID: tip-3 -:END: +### Tip #3 + While I listed this one as number three, I don't think I'd accomplish anything without it: -#+begin_quote -Document everything: even things you didn't before - such as task lists -and notes from casual calls or meetings. - -#+end_quote +> Document everything: even things you didn't before - such as task +> lists and notes from casual calls or meetings. I've noticed that staying in an office gave me more constant reminders of outstanding tasks or facts I had learned in a conversation. @@ -221,16 +196,11 @@ has improved my retention immensely. Beyond helping my mental recollection, it has saved me numerous times when I need to do a keyword search for some topic that was discussed 6+ months ago. -*** Tip #4 -:PROPERTIES: -:CUSTOM_ID: tip-4 -:END: -Okay, last one for now. +### Tip #4 -#+begin_quote -Keep your work area clean. +Okay, last one for now. -#+end_quote +> Keep your work area clean. This one is straightforward, but I know some people struggle with cleanliness or may not believe it makes a difference. Trust me, keeping @@ -241,8 +211,8 @@ Just think about it, you walk into your home office and see a clean desk with a laptop, dock, monitors, keyboard, mouse, and a notepad with a pen on top. -Now imagine the opposite, there's an office with the same equipment, but -there are clothes hanging on the chair, empty drink bottles, candy +Now imagine the opposite, there's an office with the same equipment, +but there are clothes hanging on the chair, empty drink bottles, candy wrappers and dirty plates. This can take both a mental and emotional toll by bringing constant disarray and stress into your working environment. @@ -250,14 +220,12 @@ environment. Just keep things clean each day, and you won't need to do any big cleaning days to recover. -** My Preferences -:PROPERTIES: -:CUSTOM_ID: my-preferences -:END: +## My Preferences + I've talked about the different environments I've worked in and expressed some honest thoughts on pros or cons to each, but what do I -prefer? Well, if you're reading along, you should be able to tell that I -much prefer a home office above all else. +prefer? Well, if you're reading along, you should be able to tell that +I much prefer a home office above all else. Being able to control my own day and allot my time as needed has brought a calmness to my life and has allowed me to maximize each day. I feel @@ -270,5 +238,5 @@ my work done. Cubicles are good! I agree with Alice (from the comic Dilbert): -#+caption: Dilbert comic strip -[[https://img.cleberg.net/blog/20220210-leaving-office-based-work-in-the-past/dilbert_120109.png]] + diff --git a/blog/2022-02-16-debian-and-nginx.org b/content/blog/2022-02-16-debian-and-nginx.md index 39ab36c..9e1dda6 100644 --- a/blog/2022-02-16-debian-and-nginx.org +++ b/content/blog/2022-02-16-debian-and-nginx.md @@ -1,12 +1,13 @@ -#+title: Migrating to a New Web Server Setup with Debian, Nginx, and Agate -#+date: 2022-02-16 ++++ +date = 2022-02-16 +title = "Migrating to a New Web Server Setup with Debian, Nginx, and Agate" +description = "A retrospective on my recent server migration." ++++ -** Server OS: Debian -:PROPERTIES: -:CUSTOM_ID: server-os-debian -:END: -#+caption: Debian + neofetch -[[https://img.cleberg.net/blog/20220216-migrating-to-debian-and-nginx/neofetch.png]] +## Server OS: Debian + + I've used various Linux distributions throughout the years, but I've never used anything except Ubuntu for my servers. Why? I really have no @@ -15,64 +16,62 @@ idea, mostly just comfort around the commands and software availability. However, I have always wanted to try Debian as a server OS after testing it out in a VM a few years ago (side-note: I'd love to try Alpine too, but I always struggle with compatibility). So, I decided to launch a new -VPS and use [[https://www.debian.org][Debian]] 11 as the OS. Spoiler +VPS and use [Debian](https://www.debian.org) 11 as the OS. Spoiler alert: it feels identical to Ubuntu for my purposes. I did the normal things when first launching the VPS, such as adding a new user, locking down SSH, etc. If you want to see that level of -detail, read my other post about -[[https://cleberg.net/blog/how-to-set-up-a-vps-web-server/][How to Set -Up a VPS Web Server]]. +detail, read my other post about [How to Set Up a VPS Web +Server](https://cleberg.net/blog/how-to-set-up-a-vps-web-server/). All of this has been similar, apart from small things such as the location of users' home folders. No complaints at all from me - Debian seems great. -** Web Server: Nginx -:PROPERTIES: -:CUSTOM_ID: web-server-nginx -:END: -#+caption: Nginx status -[[https://img.cleberg.net/blog/20220216-migrating-to-debian-and-nginx/nginx.png]] +## Web Server: Nginx + + Once I had the baseline server configuration set-up for Debian, I moved -on to trying out [[https://nginx.org][Nginx]] as my web server software. -This required me to install the =nginx= and =ufw= packages, as well as -setting up the initial UFW config: +on to trying out [Nginx](https://nginx.org) as my web server software. +This required me to install the `nginx` and `ufw` +packages, as well as setting up the initial UFW config: -#+begin_src sh +```sh sudo apt install nginx ufw sudo ufw allow 'Nginx Full' sudo ufw allow SSH sudo ufw enable sudo ufw status sudo systemctl status nginx -#+end_src +``` Once I had the firewall set, I moved on to creating the directories and files for my website. This is very easy and is basically the same as setting up an Apache server, so no struggles here. -#+begin_src sh +```sh sudo mkdir -p /var/www/your_domain/html sudo chown -R $USER:$USER /var/www/your_domain/html sudo chmod -R 755 /var/www/your_domain nano /var/www/your_domain/html/index.html -#+end_src +``` The next part, creating the Nginx configuration files, is quite a bit different from Apache. First, you need to create the files in the -=sites-available= folder and symlink it the =sites-enabled= folder. +`sites-available` folder and symlink it the +`sites-enabled` folder. Creating the config file for your domain: -#+begin_src sh +```sh sudo nano /etc/nginx/sites-available/your_domain -#+end_src +``` Default content for an Nginx config file: -#+begin_src sh +```sh server { listen 80; listen [::]:80; @@ -86,43 +85,45 @@ server { try_files $uri $uri/ =404; } } -#+end_src +``` Finally, symlink it together: -#+begin_src sh +```sh sudo ln -s /etc/nginx/sites-available/your_domain /etc/nginx/sites-enabled/ -#+end_src +``` This will make your site available to the public (as long as you have -=your_domain= DNS records pointed at the server's IP address)! +`your_domain` DNS records pointed at the server's IP +address)! -Next, I used [[https://certbot.eff.org/][certbot]] to issue an HTTPS +Next, I used [certbot](https://certbot.eff.org/) to issue an HTTPS certificate for my domains using the following commands: -#+begin_src sh +```sh sudo apt install snapd; sudo snap install core; sudo snap refresh core sudo snap install --classic certbot sudo ln -s /snap/bin/certbot /usr/bin/certbot sudo certbot --nginx -#+end_src +``` Now that certbot ran successfully and updated my Nginx config files to -include a =443= server block of code, I went back in and edited the -config file to include security HTTP headers. This part is optional, but -is recommended for security purposes; you can even test a website's HTTP -header security at [[https://securityheaders.com/][Security Headers]]. +include a `443` server block of code, I went back in and +edited the config file to include security HTTP headers. This part is +optional, but is recommended for security purposes; you can even test a +website's HTTP header security at [Security +Headers](https://securityheaders.com/). The configuration below shows a set-up where you only want your website to serve content from its own domain, except for images and scripts, -which may come from =nullitics.com=. All other content would be blocked -from loading in a browser. +which may come from `nullitics.com`. All other content would +be blocked from loading in a browser. -#+begin_src sh +```sh sudo nano /etc/nginx/sites-available/your_domain -#+end_src +``` -#+begin_src sh +```sh server { ... add_header Content-Security-Policy "default-src 'none'; img-src 'self' https://nullitics.com; script-src 'self' https://nullitics.com; style-src 'self'; font-src 'self'"; @@ -133,50 +134,47 @@ server { add_header Referrer-Policy "no-referrer"; ... } -#+end_src +``` -#+begin_src sh +```sh sudo systemctl restart nginx -#+end_src +``` + +### Nginx vs. Apache -*** Nginx vs. Apache -:PROPERTIES: -:CUSTOM_ID: nginx-vs.-apache -:END: As I stated at the beginning, my historical hesitation with trying Nginx was that the differences in configuration formats scared me away from leaving Apache. However, I prefer Nginx to Apache for a few reasons: -1. Nginx uses only one config file (=your_domain=) vs. Apache's two-file - approach for HTTP vs. HTTPS (=your_domain.conf= and - =your_domain-le-ssl.conf=). -2. Symlinking new configurations files and reloading Nginx are way - easier than Apache's process of having to enable headers with - =a2enmod mod_headers=, enable PHP with =a2enmod php= (plus any other - mods you need), and then enabling sites with =a2ensite=, and THEN - reloading Apache. -3. The contents of the Nginx config files seem more organized and - logical with the curly-bracket approach. This is a minor reason, but - everything just felt cleaner while I was installing my sites and that - had a big quality of life impact on the installation for me. +1. Nginx uses only one config file (`your_domain`) + vs. Apache's two-file approach for HTTP vs. HTTPS + (`your_domain.conf` and + `your_domain-le-ssl.conf`). +2. Symlinking new configurations files and reloading Nginx are way + easier than Apache's process of having to enable headers with + `a2enmod mod_headers`, enable PHP with + `a2enmod php` (plus any other mods you need), and then + enabling sites with `a2ensite`, and THEN reloading + Apache. +3. The contents of the Nginx config files seem more organized and + logical with the curly-bracket approach. This is a minor reason, but + everything just felt cleaner while I was installing my sites and + that had a big quality of life impact on the installation for me. They're both great software packages, but Nginx just seems more organized and easier to use these days. I will certainly be exploring the Nginx docs to see what other fun things I can do with all of this. -** Gemini Server: Agate -:PROPERTIES: -:CUSTOM_ID: gemini-server-agate -:END: -#+caption: Agate status -[[https://img.cleberg.net/blog/20220216-migrating-to-debian-and-nginx/agate.png]] +## Gemini Server: Agate + + Finally, I set up the Agate software on this server again to host my Gemini server content, using Rust as I have before. You can read my -other post for more information on installing Agate: -[[https://cleberg.net/blog/hosting-a-gemini-server/][Hosting a Gemini -Server]]. +other post for more information on installing Agate: [Hosting a Gemini +Server](https://cleberg.net/blog/hosting-a-gemini-server/). All in all, Debian + Nginx is very slick and I prefer it over my old -combination of Ubuntu + Apache (although it's really just Nginx > Apache -for me, since Debian seems mostly the same as Ubuntu is so far). +combination of Ubuntu + Apache (although it's really just Nginx \> +Apache for me, since Debian seems mostly the same as Ubuntu is so far). diff --git a/content/blog/2022-02-17-exiftool.md b/content/blog/2022-02-17-exiftool.md new file mode 100644 index 0000000..9948b2e --- /dev/null +++ b/content/blog/2022-02-17-exiftool.md @@ -0,0 +1,67 @@ ++++ +date = 2022-02-17 +title = "Stripping Image Metadata with exiftool" +description = "A simple guide to remove exif data with exiftool." ++++ + +## Why Strip Metadata? + +Okay, so you want to strip metadata from your photos. Perhaps you take +pictures of very rare birds, and the location metadata is a gold mine +for poachers, or perhaps you're just privacy-oriented like me and +prefer to strip metadata from publicly-available images. + +There are various components of image metadata that you may want to +delete before releasing a photo to the public. Here's an incomplete +list of things I could easily see just by inspecting a photo on my +laptop: + +- Location (Latitude & Longitude) +- Dimensions +- Device Make & Model +- Color Space +- Color Profile +- Focal Length +- Alpha Channel +- Red Eye +- Metering Mode +- F Number + +Regardless of your reasoning, I'm going to explain how I used the +`exiftool` package in Linux to automatically strip metadata +from all images in a directory (+ subdirectories). + +## Installing `exiftool` + +First things first: we need to install the tool. I'm running Debian 11 +on my server (Ubuntu will work the same), so the command is as simple +as: + +```sh +sudo apt install exiftool +``` + +There are different tools that can accomplish the same thing across +distributions, but I really only care to test out this one package. + +## Recursively Strip Data + +I actually use this tool extensively to strip any photos uploaded to the +website that serves all the images for my blog +(`img.cleberg.net`). + +The following command is incredibly useful and can be modified to +include any image extensions that `exiftool` supports: + +```sh +exiftool -r -all= -ext jpg -ext png /path/to/directory/ +``` + +See below for the results of my most recent usage of +`exiftool` after I uploaded the image for this blog post. You +can see that the command will let you know how many directories were +scanned, how many images were updated, and how many images were +unchanged. + + diff --git a/content/blog/2022-02-20-nginx-caching.md b/content/blog/2022-02-20-nginx-caching.md new file mode 100644 index 0000000..5c5d29b --- /dev/null +++ b/content/blog/2022-02-20-nginx-caching.md @@ -0,0 +1,72 @@ ++++ +date = 2022-02-20 +title = "Caching Static Content with Nginx" +description = "Learn how to enable the static content cache in Nginx." ++++ + +## Update Your Nginx Config to Cache Static Files + +If you run a website on Nginx that serves static content (i.e., content +that is not dynamic and changing with interactions from the user), you +would likely benefit from caching that content on the client-side. If +you're used to Apache and looking for the Nginx equivalent, this post +should help. + +Luckily, setting up the cache is as easy as identifying the file types +you want to cache and determining the expiration length. To include more +file types, simply use the bar separator (`|`) and type the +new file extension you want to include. + +```config +server { + ... + + location ~* .(css|js|jpg|jpeg|gif|png|ico)$ { + expires 30d; + } + + ... +} +``` + +I have seen some people who prefer to set `expires` as +`365d` or even `max`, but that is only for stable, +infrequently changing websites. As my site often changes (i.e., I'm +never content with my website), I need to know that my readers are +seeing the new content without waiting too long. + +So, I went ahead and set the expiration date at `30d`, which +is short enough to refresh for readers but long enough that +clients/browsers won't be re-requesting the static files too often, +hopefully resulting in faster loading times, as images should be the +only thing slowing down my site. + +## Testing Results + +To test my changes to the Nginx configuration, I used the [HTTP Header +Live](https://addons.mozilla.org/en-US/firefox/addon/http-header-live/) +extension on my Gecko browser and used the sidebar to inspect the +headers of a recent image from my blog. + +In the image below, you can see that the `Cache-Control` +header is now present and set to 2592000, which is 30 days represented +in seconds (30 days \_ 24 hours/day \_ 60 minutes/hour \* 60 +seconds/minute = 2,592,000 seconds). + +The `Expires` field is now showing 22 March 2022, which is 30 +days from the day of this post, 20 February 2022. + + + +## Caveats + +Remember that this caching system is **client-side**, which means that +content is only cached for as long as a client allows it. For example, +my browser purges all caches, data, etc. upon exit, so this caching +policy will only work as long as my browser remains open and running. + +If you need to test updates to your site, you'll need to clear the +cache to see updates for any file extension you configured. This can +often be done with the `Shift + F5` or `Ctrl + F5` +key combinations in most browsers. diff --git a/content/blog/2022-02-22-tuesday.md b/content/blog/2022-02-22-tuesday.md new file mode 100644 index 0000000..dabaa6d --- /dev/null +++ b/content/blog/2022-02-22-tuesday.md @@ -0,0 +1,41 @@ ++++ +date = 2022-02-22 +title = "Tuesday" +description = "2-22-22 || 22-2-22" ++++ + +## Tuesday, Twosday + +I'm taking a break from my usual technology-related posts and writing +about something a little more enjoyable today. + +Today is Tuesday, February 22nd, 2022. Today is 02-22-2022. Today is +Twosday. + +Let's look at everything that fell in place today: + +1. Written in the `m-dd-yy` or `dd-m-yy` formats, + today is 2-22-22 or 22-2-22, which is a neat little palindrome in + either format. (The last ubiquitous six-digit palindrome was + 1-11-11.) +2. Today is Tuesday, which is why everyone is using the nickname + Twosday to call out these similarities. +3. Falling on Tuesday means today is the 2nd day of the week (for most + cultures. For the US, it's the 3rd day of the week since we start + on Sunday). +4. The only culture I could find with a connection to a `2` + is that some Slavic languages derived their version of Tuesday from + the Old Church Slavonic word `въторъ`, meaning "the + second." +5. Written in the classic monospaced, digital font (think of digital + clocks from the 80s/90s), there is nice symmetry to the numbers + ([view the image + here](https://img.cleberg.net/blog/20220222-tuesday/digital_font.png)!). +6. This one isn't naturally-occurring, but it seems people around the + world are celebrating the day. For example, a group is putting + together + [[<https://www.eventbrite.com/e/2-22-22-a-collective-wedding-ceremony-at-the-state-capitol-tickets-211434605597>][a + wedding of 222 couples at the California State Capitol in + Sacramento]], concluding at exactly 2:22 PM. These couples will + record their marriage dates as 2-22-22 2:22 PM. Tickets were on sale + for \$222.22. diff --git a/blog/2022-03-02-note-taking.org b/content/blog/2022-03-02-note-taking.md index 15f0b7c..88fd704 100644 --- a/blog/2022-03-02-note-taking.org +++ b/content/blog/2022-03-02-note-taking.md @@ -1,19 +1,16 @@ -#+title: Easy, Reliable Note-Taking -#+date: 2022-03-02 ++++ +date = 2022-03-02 +title = "Easy, Reliable Note-Taking" +description = "My personal preferences to ensure notes are clear, portable, and long-lasting." ++++ -** Choosing Durable File Formats -:PROPERTIES: -:CUSTOM_ID: choosing-durable-file-formats -:END: +## Choosing Durable File Formats -#+begin_quote -TL;DR: Write in a format that can be easily rendered and read in -plain-text mode (e.g., =.txt=, =.md=, etc.). +> TL;DR: Write in a format that can be easily rendered and read in +> plain-text mode (e.g., `.txt`, `.md`, etc.). -#+end_quote - -As I've written more and more over the years, I've found that my love of -note-taking is always growing. Everything I learn or need to remember +As I've written more and more over the years, I've found that my love +of note-taking is always growing. Everything I learn or need to remember can be written down in a note and saved digitally, with no cost to myself. Unlike paper copies that need physical storage space, digital files simply need space on your local disk or cloud storage, which is @@ -25,8 +22,8 @@ styling. This meant that I had to go through each note during migration and edit the file to look presentable again. For the last year or two, I have written everything exclusively in -[[https://en.wikipedia.org/wiki/Markdown][Markdown]] format. Small -notes, long-form writings, and even these blog posts are all written in +[Markdown](https://en.wikipedia.org/wiki/Markdown) format. Small notes, +long-form writings, and even these blog posts are all written in Markdown. Why Markdown? While I do appreciate the simplicity of plain-text files @@ -34,21 +31,19 @@ without any formatting, I often need visual cues such as heading and code blocks to keep my thoughts straight. Markdown provides a minimal set of styling indicators for me to style my notes without adding any proprietary, embedded data into the files. If I want a top-level -heading, I simply add a hash (=#=) before the line. An added bonus is -that even if a system doesn't understand Markdown, it will render it as -plain-text and I can read it just as easily. +heading, I simply add a hash (`#`) before the line. An added +bonus is that even if a system doesn't understand Markdown, it will +render it as plain-text and I can read it just as easily. For example, here's how TextEdit on macOS will open and display a Markdown file in plain-text, since it does contain any features to preview Markdown as HTML: -#+caption: Plain Text Markdown -[[https://img.cleberg.net/blog/20220302-easy-reliable-note-taking/plain_markdown.png]] + + +## Saving & Syncing Files -** Saving & Syncing Files -:PROPERTIES: -:CUSTOM_ID: saving-syncing-files -:END: In order to read and edit my notes across platforms, I use my personal cloud storage through Tresorit due to its native integration with macOS and iOS file managers. In addition, Tresorit works well on Debian-based @@ -64,23 +59,19 @@ me to sync anything manually or kick-off a sync job to update my files. This means that I can edit on mobile, and it takes about 5-10 seconds to see the changes on desktop. -*** Version Control with Git -:PROPERTIES: -:CUSTOM_ID: version-control-with-git -:END: +### Version Control with Git + A different approach I've contemplated is storing my notes and attachments is using a hosted Git repository to track changes to the files. However, I don't want to rely on an external service that could potentially see into my data, even if the repository is private. -I might just do =git init= locally and then commit my changes each time -I write or update a note, but that seems to be a lot of work just for -tracking changes - which I don't necessarily care to know. +I might just do `git init` locally and then commit my changes +each time I write or update a note, but that seems to be a lot of work +just for tracking changes - which I don't necessarily care to know. + +### Backups! -*** Backups! -:PROPERTIES: -:CUSTOM_ID: backups -:END: One small addition to the storage/sync conversation is the idea of backups. Personally, I manually create periodic backups of my entire cloud storage, compress it into an archive, and store it on my home @@ -90,18 +81,12 @@ To improve my workflow, I am going to be exploring options to automatically compress the mounted cloud directory and send it over to my server on a set schedule. -** Writing on Desktop -:PROPERTIES: -:CUSTOM_ID: writing-on-desktop -:END: +## Writing on Desktop -#+begin_quote -*Update (06.14.22)*: Since writing this post, I have reverted to simply -keeping my =notes= folder open and opening notes individually in -TextEdit for a more minimal and relaxing writing experience on the -desktop. - -#+end_quote +> **Update (06.14.22)**: Since writing this post, I have reverted to +> simply keeping my `notes` folder open and opening notes +> individually in TextEdit for a more minimal and relaxing writing +> experience on the desktop. The bulk of my writing occurs in a desktop environment, with a full keyboard layout and wide screen. I don't illustrate with a smart pen, I @@ -109,36 +94,31 @@ rarely use embedded images, and I love being able to see all of my notes/directories in a sidebar. With this simple set of requirements, I chose -[[https://obsidian.md][Obsidian]] as my desktop text editor. Obsidian -has some in-depth tools like a graph view, command palette, mentions, -etc., but I've found that using it as a simple Markdown editor is -incredibly easy and straightforward. +[Obsidian](https://obsidian.md) as my desktop text editor. Obsidian has +some in-depth tools like a graph view, command palette, mentions, etc., +but I've found that using it as a simple Markdown editor is incredibly +easy and straightforward. Here's an example of how my Markdown notes look when opened in plain-text mode: -#+caption: Obsidian Markdown Source Mode -[[https://img.cleberg.net/blog/20220302-easy-reliable-note-taking/obsidian_source_mode.png]] + + +Here's the "live preview" version, where the Markdown is rendered +into its HTML format: -Here's the "live preview" version, where the Markdown is rendered into -its HTML format: + -#+caption: Obsidian Markdown Live Preview -[[https://img.cleberg.net/blog/20220302-easy-reliable-note-taking/obsidian_live_preview.png]] +### Programming on Desktop -*** Programming on Desktop -:PROPERTIES: -:CUSTOM_ID: programming-on-desktop -:END: While I was writing this, I realized I should specify that I don't use the same editor for writing notes and for writing code. For programming -purposes, I use [[https://vscodium.com][VSCodium]] as my development -IDE. +purposes, I use [VSCodium](https://vscodium.com) as my development IDE. + +## Writing on Mobile -** Writing on Mobile -:PROPERTIES: -:CUSTOM_ID: writing-on-mobile -:END: Personally, I write very little on mobile, except when needing to take important notes on-the-go. Any long-form writing, journals, etc. are done at home, where I always have my laptop available. @@ -146,9 +126,9 @@ done at home, where I always have my laptop available. I wanted a simple and foolproof editor for iOS, preferably open-source. After a long journey of testing the few (& terrible) open-source iOS note-taking apps, I finally found a phenomenal one: -[[https://github.com/simonbs/runestone][Runestone]]. This app is -fantastic for note-taking, has plenty of optional features, and -integrates natively with the iOS file manager. +[Runestone](https://github.com/simonbs/runestone). This app is fantastic +for note-taking, has plenty of optional features, and integrates +natively with the iOS file manager. This app opens the iOS file manager and allows you to click any file you want, opens it up in an editor, and lets me save and close out of that diff --git a/content/blog/2022-03-03-financial-database.md b/content/blog/2022-03-03-financial-database.md new file mode 100644 index 0000000..e3a1d81 --- /dev/null +++ b/content/blog/2022-03-03-financial-database.md @@ -0,0 +1,271 @@ ++++ +date = 2022-03-03 +title = "Maintaining a Personal Financial Database" +description = "An example project showing to build and maintain a simple financial database." ++++ + +## Personal Financial Tracking + +For the last 6-ish years, I've tracked my finances in a spreadsheet. +This is common practice in the business world, but any good dev will +cringe at the thought of storing long-term data in a spreadsheet. A +spreadsheet is not for long-term storage or as a source of data to pull +data/reports. + +As I wanted to expand the functionality of my financial data (e.g., +adding more reports), I decided to migrate the data into a database. To +run reports, I would query the database and use a language like Python +or Javascript to process the data, perform calculations, and visualize +the data. + +## SQLite + +When choosing the type of database I wanted to use for this project, I +was split between three options: + +1. MySQL: The database I have the most experience with and have used + for years. +2. PostgreSQL: A database I'm new to, but want to learn. +3. SQLite: A database that I've used for a couple projects and have + moderate experience. + +I ended up choosing SQLite since it can be maintained within a single +`.sqlite` file, which allows me more flexibility for storage +and backup. I keep this file in my cloud storage and pull it up whenever +needed. + +### GUI Editing + +Since I didn't want to try and import 1000--1500 records into my new +database via the command line, I opted to use [DB Browser for SQLite +(DB4S)](https://sqlitebrowser.org/) as a GUI tool. This application is +excellent, and I don't see myself going back to the CLI when working in +this database. + +DB4S allows you to copy a range of cells from a spreadsheet and paste it +straight into the SQL table. I used this process for all 36 accounts, +1290 account statements, and 126 pay statements. Overall, I'm guessing +this took anywhere between 4--8 hours. In comparison, it probably took +me 2-3 days to initially create the spreadsheet. + + + +### Schema + +The schema for this database is actually extremely simple and involves +only three tables (for now): + +1. Accounts +2. Statements +3. Payroll + +**Accounts** + +The Accounts table contains summary information about an account, such +as a car loan or a credit card. By viewing this table, you can find +high-level data, such as interest rate, credit line, or owner. + +```sql +CREATE TABLE "Accounts" ( + "AccountID" INTEGER NOT NULL UNIQUE, + "AccountType" TEXT, + "AccountName" TEXT, + "InterestRate" NUMERIC, + "CreditLine" NUMERIC, + "State" TEXT, + "Owner" TEXT, + "Co-Owner" TEXT, + PRIMARY KEY("AccountID" AUTOINCREMENT) +) +``` + +**Statements** + +The Statements table uses the same unique identifier as the Accounts +table, meaning you can join the tables to find a monthly statement for +any of the accounts listed in the Accounts table. Each statement has an +account ID, statement date, and total balance. + +```sql +CREATE TABLE "Statements" ( + "StatementID" INTEGER NOT NULL UNIQUE, + "AccountID" INTEGER, + "StatementDate" INTEGER, + "Balance" NUMERIC, + PRIMARY KEY("StatementID" AUTOINCREMENT), + FOREIGN KEY("AccountID") REFERENCES "Accounts"("AccountID") +) +``` + +**Payroll** + +The Payroll table is a separate entity, unrelated to the Accounts or +Statements tables. This table contains all information you would find on +a pay statement from an employer. As you change employers or obtain new +perks/benefits, just add new columns to adapt to the new data. + +```sql +CREATE TABLE "Payroll" ( + "PaycheckID" INTEGER NOT NULL UNIQUE, + "PayDate" TEXT, + "Payee" TEXT, + "Employer" TEXT, + "JobTitle" TEXT, + "IncomeRegular" NUMERIC, + "IncomePTO" NUMERIC, + "IncomeHoliday" NUMERIC, + "IncomeBonus" NUMERIC, + "IncomePTOPayout" NUMERIC, + "IncomeReimbursements" NUMERIC, + "FringeHSA" NUMERIC, + "FringeStudentLoan" NUMERIC, + "Fringe401k" NUMERIC, + "PreTaxMedical" NUMERIC, + "PreTaxDental" NUMERIC, + "PreTaxVision" NUMERIC, + "PreTaxLifeInsurance" NUMERIC, + "PreTax401k" NUMERIC, + "PreTaxParking" NUMERIC, + "PreTaxStudentLoan" NUMERIC, + "PreTaxOther" NUMERIC, + "TaxFederal" NUMERIC, + "TaxSocial" NUMERIC, + "TaxMedicare" NUMERIC, + "TaxState" NUMERIC, + PRIMARY KEY("PaycheckID" AUTOINCREMENT) +) +``` + +### Python Reporting + +Once I created the database tables and imported all my data, the only +step left was to create a process to report and visualize on various +aspects of the data. + +In order to explore and create the reports I'm interested in, I +utilized a two-part process involving Jupyter Notebooks and Python +scripts. + +1. Step 1: Jupyter Notebooks + + When I need to explore data, try different things, and re-run my + code cell-by-cell, I use Jupyter Notebooks. For example, I explored + the `Accounts` table until I found the following useful + information: + + ```python + import sqlite3 + import pandas as pd + import matplotlib + + # Set up database filename and connect + db = "finances.sqlite" + connection = sqlite3.connect(db) + df = pd.read_sql_query("SELECT * FROM Accounts", connection) + + # Set global matplotlib variables + %matplotlib inline + matplotlib.rcParams['text.color'] = 'white' + matplotlib.rcParams['axes.labelcolor'] = 'white' + matplotlib.rcParams['xtick.color'] = 'white' + matplotlib.rcParams['ytick.color'] = 'white' + matplotlib.rcParams['legend.labelcolor'] = 'black' + + # Display graph + df.groupby(['AccountType']).sum().plot.pie(title='Credit Line by Account Type', y='CreditLine', figsize=(5,5), autopct='%1.1f%%') + ``` + +2. Step 2: Python Scripts + + Once I explored enough through the notebooks and had a list of + reports I wanted, I moved on to create a Python project with the + following structure: + + ```example + finance/ + ├── notebooks/ + │ │ ├── account_summary.ipynb + │ │ ├── account_details.ipynb + │ │ └── payroll.ipynb + ├── public/ + │ │ ├── image-01.png + │ │ └── image-0X.png + ├── src/ + │ └── finance.sqlite + ├── venv/ + ├── _init.py + ├── database.py + ├── process.py + ├── requirements.txt + └── README.md + ``` + + This structure allows me to: + + 1. Compile all required python packages into + `requirements.txt` for easy installation if I move to + a new machine. + 2. Activate a virtual environment in `venv/` so I don't + need to maintain a system-wide Python environment just for this + project. + 3. Keep my `notebooks/` folder to continuously explore + the data as I see fit. + 4. Maintain a local copy of the database in `src/` for + easy access. + 5. Export reports, images, HTML files, etc. to + `public/`. + + Now, onto the differences between the code in a Jupyter Notebook and + the actual Python files. To create the report in the Notebook + snippet above, I created the following function inside + `process.py`: + + ```python + # Create summary pie chart + def summary_data(accounts: pandas.DataFrame) -> None: + accounts_01 = accounts[accounts["Owner"] == "Person01"] + accounts_02 = accounts[accounts["Owner"] == "Person02"] + for x in range(1, 4): + if x == 1: + df = accounts + account_string = "All Accounts" + elif x == 2: + df = accounts_01 + account_string = "Person01's Accounts" + elif x == 3: + df = accounts_02 + account_string = "Person02's Accounts" + print(f"Generating pie chart summary image for {account_string}...") + summary_chart = ( + df.groupby(["AccountType"]) + .sum() + .plot.pie( + title=f"Credit Line by Type for {account_string}", + y="CreditLine", + autopct="%1.1f%%", + ) + ) + summary_chart.figure.savefig(f"public/summary_chart_{x}.png", dpi=1200) + ``` + + The result? A high-quality pie chart that is read directly by the + `public/index.html` template I use. + +  + + Other charts generated by this project include: + + - Charts of account balances over time. + - Line chart of effective tax rate (taxes divided by taxable + income). + - Salary projections and error limits using past income and + inflation rates. + - Multi-line chart of gross income, taxable income, and net + income. + + The best thing about this project? I can improve it at any given + time, shaping it into whatever helps me the most for that time. I + imagine that I will be introducing an asset tracking table soon to + track the depreciating value of cars, houses, etc. Who knows what's + next? diff --git a/content/blog/2022-03-08-plex-migration.md b/content/blog/2022-03-08-plex-migration.md new file mode 100644 index 0000000..0b4d900 --- /dev/null +++ b/content/blog/2022-03-08-plex-migration.md @@ -0,0 +1,253 @@ ++++ +date = 2022-03-08 +title = "Migrating Plex to a New Server (& Nvidia Transcoding)" +description = "A retrospective on migrating Plex between servers and enabling Nvidia GPU transcoding." ++++ + +## Migration Phases + +I recently decided to migrate my server from an old OptiPlex desktop +machine to a custom-built tower with better hardware in every category. +In order to do this, I would need to properly migrate a full Plex +installation. + +The second part of this migration is that the new server uses an Nvidia +GPU and does not have any integrated graphics, which requires extra work +for installation, but provides much better hardware transcoding options +for Plex. + +Therefore, I have broken this migration down into three phases: + +1. [Configure the New Server](#phase-1-configure-the-new-server) +2. [Migrate Plex Data & Devices](#phase-2-migrate-plex-data-devices) +3. [Configure GPU Transcoding](#phase-3-configure-gpu-transcoding) + +------------------------------------------------------------------------ + +## Phase 1: Configure the New Server + +### Choosing an OS + +In order to migrate Plex to my new server, I first needed to choose an +appropriate operating system (OS) and install it on the machine. Given +that I have encountered numerous issues installing other Linux +distributions properly with Nvidia graphics, I chose [Ubuntu +Server](https://ubuntu.com/download/server). + +The first step is to create a bootable USB with Ubuntu Server. This is +easy with [Etcher](https://www.balena.io/etcher/), an app that runs on +many different platforms. Just download the Ubuntu Server +`.iso` image, launch Etcher, and install the +`.iso` on the USB. + +Once the USB is created, insert it into my server, reboot, and click +`Esc` (or any of the `F1-12` keys) until the BIOS +menu appears. Finally, launch the USB boot drive. + +### Booting with Nvidia + +In order to install Ubuntu Server with an Nvidia Graphics card (and no +integrated graphics on this device for some reason), you'll have to +configure the boot menu to allow different graphics drivers to be +loaded. + +When booting from the USB, the machine will launch the initial +installation menu. From this menu, type `e` to view the +default command options that come with the device - it's a good idea to +take a photo of this screen, so you can enter these commands on the next +screen (along with adding support for Nvidia). + +Finally, type `Ctrl + C` to enter the command line. From this +command line, enter the commands found on the `e` screen. +\*Remember to add `nomodeset` to the `linux ...` +line so that your Nvidia device will display the installation screens +properly!\* + +Here's an example of the commands I pulled from the `e` +screen and entered on the command line. + +```sh +setparams 'Install Ubuntu Server' +setgfxpayload=keep +linux /casper/vmlinuz quiet nomodeset --- +initrd /casper/initrd +boot +``` + + + + + +Once the machine is rebooted, enter the `e` screen again and +add `nomodeset` to the `linux ...` line again and +press `Ctrl + X` to save the boot options. + +The machine is now fully installed and can properly display on an +external display using the Nvidia GPU. + +Always remember to update and upgrade on a new installation: + +```sh +sudo apt update; sudo apt upgrade -y; sudo apt autoremove -y +``` + +------------------------------------------------------------------------ + +## Phase 2: Migrate Plex Data & Devices + +This phase uses the great Plex article on migrations ([Move an +Installation to Another +System](https://support.plex.tv/articles/201370363-move-an-install-to-another-system/)) +and adds a bit more information to help with commands and context. + +### Terminology + +**Source:** The original server that is being replaced.\ +**Destination:** The new server.\ +**Client:** Any application that can be used to modify settings for both +source/destination. + +### Step 01: [Client] Update Settings + +Open up a Plex app and *disable* the `Account` \> +`Library` \> +`Empty trash automatically after every scan` preference for +the source server. + +### Step 02: [Destination] Install Plex + +Open up the [Plex Media Server download +page](https://www.plex.tv/media-server-downloads/) and copy the link for +the appropriate platform. + +Execute the following commands on the destination server to install +Plex: + +```sh +wget <url> +sudo dpkg -i <filename> +sudo systemctl stop plexmediaserver.service +``` + +### Step 03: [Source] Stop Plex & Migrate Data + +First, stop the Plex service so that no data is created or modified +during the migration. + +```sh +sudo systemctl stop plexmediaserver.service +``` + +Next, copy the data to the new server. To find where the Plex data +directory is located, Plex has another excellent article available: +[Where is the Plex Media Server data directory +located?](https://support.plex.tv/articles/202915258-where-is-the-plex-media-server-data-directory-located/). + +There are many ways to copy the data to the new server and will largely +depend on the size of the folder being copied. Personally, my data +folder was \~23GB and I opted to simply use the `scp` command +to copy the files over SSH. + +This process was throttled by the old server's slow HDD and ports and +took approximately 90 minutes to complete. In comparison, moving the +data from the new server's `home/user/` directory to the +`/var/.../Plex Media Server` directory took 2-3 minutes. + +```sh +scp -r "/var/lib/plexmediaserver/Library/Application Support/Plex Media Server" your_user@xxx.xxx.xxx.xxx:"'/path/to/destination/'" +``` + +### Step 04: [Destination] Update File Permissions + +In case you move the data directory to a common area on the new server, +it will have to be moved to the proper location before Plex can function +properly: + +```sh +mv "Plex Media Server" /var/lib/plexmediaserver/Library/Application Support/ +``` + +To ensure permissions were retained properly, the server will need to +show that all files and folders in the data directory are owned by +`plex:plex` (or whichever user is running the Plex +application). + +```sh +sudo chown -R plex:plex "/var/lib/plexmediaserver/Library/Application Support/Plex Media Server" +``` + +Finally, start the service and check the status. + +```sh +sudo systemctl start plexmediaserver.service +sudo systemctl status plexmediaserver.service +``` + +### Step 05: [Client] Update Libraries & Metadata + +The first step - now that the new server is up and running - is to sign +out of the client and sign back in. Once this is done, update any +library locations, if necessary. This was unnecessary in my case since I +simply moved my storage drives from the source server to the destination +server. + +Next, perform the following actions in the client: + +1. On the left sidebar, click `More` \> Three-Dot Menu \> + `Scan Library Files` +2. *Enable* the `Account` \> `Library` \> + `Empty trash automatically after every scan` preference + for the source server. +3. On the left sidebar, click `More` \> Three-Dot Menu \> + `Manage Server` \> `Empty Trash` +4. On the left sidebar, click `More` \> Three-Dot Menu \> + `Manage Server` \> `Clean Bundles` +5. On the left sidebar, click `More` \> Three-Dot Menu \> + `Manage Server` \> `Optimize Database` + +Finally, double-check the Remote Access settings to make sure no changes +have caused issues with accessing the server from outside the network. + +In my case, I use a single port forwarding rule in my router and needed +to update the Local LAN IP Address to the new server IP address. + + + +------------------------------------------------------------------------ + +## Phase 3: Configure GPU Transcoding + +The final piece to the migration is enabling hardware transcoding so +that Plex can fully utilize the new Nvidia GPU available in the server. +The first step is to install Nvidia graphics drivers. This process may +take a few minutes, but the commands are pretty simple: + +```sh +sudo add-apt-repository ppa:graphics-drivers/ppa +sudo apt update +sudo apt-get install ubuntu-drivers-common +sudo ubuntu-drivers autoinstall +``` + +Finally, reboot so that the changes are loaded: + +```sh +sudo reboot now +``` + +To ensure that the Nvidia graphics drivers are working properly, run the +following command to view the available GPUs, statistics, and processes: + +```sh +sudo nvidia-smi +``` + + + +Finally, enable hardware transcoding settings in the Plex application: + + diff --git a/blog/2022-03-23-cloudflare-dns-api.org b/content/blog/2022-03-23-cloudflare-dns-api.md index 3a80a71..5dddb92 100644 --- a/blog/2022-03-23-cloudflare-dns-api.org +++ b/content/blog/2022-03-23-cloudflare-dns-api.md @@ -1,40 +1,41 @@ -#+title: Dynamic DNS with Cloudflare API -#+date: 2022-03-23 - -** DDNS: Dynamic DNS -:PROPERTIES: -:CUSTOM_ID: ddns-dynamic-dns -:END: -If you're hosting a service from a location with dynamic DNS (where your -IP may change at any time), you must have a solution to update the DNS -so that you can access your service even when the IP of the server ++++ +date = 2022-03-23 +title = "Dynamic DNS with Cloudflare API" +description = "Learn how to dynamically update DNS records for changing IPs with Cloudflare." ++++ + +## DDNS: Dynamic DNS + +If you're hosting a service from a location with dynamic DNS (where +your IP may change at any time), you must have a solution to update the +DNS so that you can access your service even when the IP of the server changes. -The process below uses the [[https://api.cloudflare.com/][Cloudflare -API]] to update DNS =A= and =AAAA= records with the server's current IP. -If you use another DNS provider, you will have to find a way to update -your DNS (or find a way to get a static IP). +The process below uses the [Cloudflare API](https://api.cloudflare.com/) +to update DNS `A` and `AAAA` records with the +server's current IP. If you use another DNS provider, you will have to +find a way to update your DNS (or find a way to get a static IP). -First, install =jq= since we will use it in the next script: +First, install `jq` since we will use it in the next script: -#+begin_src sh +```sh sudo apt install jq -#+end_src +``` Next, create a location for your DDNS update scripts and open the first script: -#+begin_src sh +```sh mkdir ~/ddns nano ~/ddns/update.sh -#+end_src +``` -The following =update.sh= script will take all of your domains and -subdomains and check Cloudflare to see if the current =A= and =AAAA= -records match your server's IP address. If not, it will update the -records. +The following `update.sh` script will take all of your +domains and subdomains and check Cloudflare to see if the current +`A` and `AAAA` records match your server's IP +address. If not, it will update the records. -#+begin_src sh +```sh # file: update.sh #!/bin/bash @@ -56,20 +57,22 @@ do echo -e "\nUpdating $subdomain..." zone_name=$domain dns_record=$subdomain /home/<your-username>/ddns/ddns.sh done -#+end_src +``` -Next, open up the =ddns.sh= script. Paste the following into the script -and update the =api_token= and =email= variables. +Next, open up the `ddns.sh` script. Paste the following into +the script and update the `api_token` and `email` +variables. -#+begin_src sh +```sh nano ~/ddns/ddns.sh -#+end_src +``` -:warning: *Note*: If you want your DNS records to be proxied through -Cloudflare, find and update the following snippet: =\"proxied\":false}"= -to say =true= instead of =false=. +:warning: **Note**: If you want your DNS records to be proxied through +Cloudflare, find and update the following snippet: +`"proxied":false}"` to say `true` instead of +`false`. -#+begin_src sh +```sh # file: ddns.sh #!/bin/bash # based on https://gist.github.com/Tras2/cba88201b17d765ec065ccbedfb16d9a @@ -121,7 +124,7 @@ then -H "Content-Type: application/json" \ -H "X-Auth-Email: $email" \ -H "Authorization: Bearer $api_token" \ - --data "{\"type\":\"A\",\"name\":\"$dns_record\",\"content\":\"$ipv4\",\"ttl\":1,\"proxied\":false}" \ + --data "{"type":"A","name":"$dns_record","content":"$ipv4","ttl":1,"proxied":false}" \ | jq -r '.errors' else echo "The current IPv4 and DNS record IPv4 are the same." @@ -148,7 +151,7 @@ then -H "Content-Type: application/json" \ -H "X-Auth-Email: $email" \ -H "Authorization: Bearer $api_token" \ - --data "{\"type\":\"AAAA\",\"name\":\"$dns_record\",\"content\":\"$ipv6\",\"ttl\":1,\"proxied\":false}" \ + --data "{"type":"AAAA","name":"$dns_record","content":"$ipv6","ttl":1,"proxied":false}" \ | jq -r '.errors' else echo "The current IPv6 and DNS record IPv6 are the same." @@ -162,30 +165,31 @@ then else echo "There is a problem with either the email or the password" fi -#+end_src +``` Once the script is saved and closed, make the scripts executable: -#+begin_src sh +```sh chmod +x ~/ddns/ddns.sh chmod +x ~/ddns/update.sh -#+end_src +``` You can test the script by running it manually: -#+begin_src sh +```sh ./update.sh -#+end_src +``` -To make sure the scripts run automatically, add it to the =cron= file so -that it will run on a schedule. To do this, open the cron file: +To make sure the scripts run automatically, add it to the +`cron` file so that it will run on a schedule. To do this, +open the cron file: -#+begin_src sh +```sh crontab -e -#+end_src +``` In the cron file, paste the following at the bottom of the editor: -#+begin_src sh +```sh */5 * * * * bash /home/<your_username>/ddns/update.sh -#+end_src +``` diff --git a/blog/2022-03-23-nextcloud-on-ubuntu.org b/content/blog/2022-03-23-nextcloud-on-ubuntu.md index c28da25..5bb395f 100644 --- a/blog/2022-03-23-nextcloud-on-ubuntu.org +++ b/content/blog/2022-03-23-nextcloud-on-ubuntu.md @@ -1,90 +1,83 @@ -#+title: Installing Nextcloud on Ubuntu -#+date: 2022-03-23 - -** What is Nextcloud? -:PROPERTIES: -:CUSTOM_ID: what-is-nextcloud -:END: -[[https://nextcloud.com/][Nextcloud]] is a self-hosted solution for ++++ +date = 2022-03-23 +title = "Installing Nextcloud on Ubuntu" +description = "A guide to self-hosting the NextCloud application on your own server." ++++ + +## What is Nextcloud? + +[Nextcloud](https://nextcloud.com/) is a self-hosted solution for storage, communications, editing, calendar, contacts, and more. This tutorial assumes that you have an Ubuntu server and a domain name configured to point toward the server. -** Install Dependencies -:PROPERTIES: -:CUSTOM_ID: install-dependencies -:END: +## Install Dependencies + To start, you will need to install the packages that Nextcloud requires: -#+begin_src sh +```sh sudo apt install apache2 mariadb-server libapache2-mod-php7.4 sudo apt install php7.4-gd php7.4-mysql php7.4-curl php7.4-mbstring php7.4-intl sudo apt install php7.4-gmp php7.4-bcmath php-imagick php7.4-xml php7.4-zip -#+end_src +``` -** Set Up MySQL -:PROPERTIES: -:CUSTOM_ID: set-up-mysql -:END: -Next, you will need to log in to MySQL as the =root= user of the -machine. +## Set Up MySQL -#+begin_src sh +Next, you will need to log in to MySQL as the `root` user of +the machine. + +```sh sudo mysql -uroot -p -#+end_src +``` Once you've logged in, you must create a new user so that Nextcloud can -manage the database. You will also create a =nextcloud= database and -assign privileges: +manage the database. You will also create a `nextcloud` +database and assign privileges: -#+begin_src sql +```sql CREATE USER 'username'@'localhost' IDENTIFIED BY 'password'; CREATE DATABASE IF NOT EXISTS nextcloud CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci; GRANT ALL PRIVILEGES ON nextcloud.* TO 'username'@'localhost'; FLUSH PRIVILEGES; quit; -#+end_src +``` + +## Download & Install Nextcloud -** Download & Install Nextcloud -:PROPERTIES: -:CUSTOM_ID: download-install-nextcloud -:END: -To download Nextcloud, go the -[[https://nextcloud.com/install/#instructions-server][Nextcloud -downloads page]], click on =Archive File= and right-click the big blue -button to copy the link. +To download Nextcloud, go the [Nextcloud downloads +page](https://nextcloud.com/install/#instructions-server), click on +`Archive File` and right-click the big blue button to copy +the link. Then, go to your server and enter the following commands to download, unzip, and move the files to your destination directory. This example -uses =example.com= as the destination, but you can put it wherever you -want to server your files from. +uses `example.com` as the destination, but you can put it +wherever you want to server your files from. -#+begin_src sh +```sh wget https://download.nextcloud.com/server/releases/nextcloud-23.0.3.zip sudo apt install unzip unzip nextcloud-23.0.3.zip sudo cp -r nextcloud /var/www/example.com -#+end_src +``` + +## Configure the Apache Web Server -** Configure the Apache Web Server -:PROPERTIES: -:CUSTOM_ID: configure-the-apache-web-server -:END: Now that the database is set up and Nextcloud is installed, you need to set up the Apache configuration files to tell the server how to handle -requests for =example.com/nextcloud=. +requests for `example.com/nextcloud`. First, open the following file in the editor: -#+begin_src sh +```sh sudo nano /etc/apache2/sites-available/nextcloud.conf -#+end_src +``` Once the editor is open, paste the following information in. Then, save and close the file. -#+begin_src config +```config <VirtualHost *:80> DocumentRoot /var/www/example.com ServerName example.com @@ -103,79 +96,74 @@ and close the file. </IfModule> </Directory> </VirtualHost> -#+end_src +``` Once the file is saved, enable it with Apache: -#+begin_src sh +```sh sudo a2ensite nextcloud.conf -#+end_src +``` Next, enable the Apache mods required by Nextcloud: -#+begin_src sh +```sh sudo a2enmod rewrite headers env dir mime -#+end_src +``` Finally, restart Apache. If any errors arise, you must solve those before continuing. -#+begin_src sh +```sh sudo systemctl restart apache2 -#+end_src +``` For the app to work, you must have the correct file permissions on your -=nextcloud= directory. Set the owner to be =www-data=: +`nextcloud` directory. Set the owner to be +`www-data`: -#+begin_src sh +```sh sudo chown -R www-data:www-data /var/www/example.com/nextcloud/ -#+end_src +``` + +## DNS -** DNS -:PROPERTIES: -:CUSTOM_ID: dns -:END: If you do not have a static IP address, you will need to update your DNS settings (at your DNS provider) whenever your dynamic IP address changes. For an example on how I do that with Cloudflare, see my other post: -[[/blog/updating-dynamic-dns-with-cloudflare-api/][Updating Dynamic DNS -with Cloudflare API]] +[Updating Dynamic DNS with Cloudflare +API](/blog/updating-dynamic-dns-with-cloudflare-api/) + +## Certbot -** Certbot -:PROPERTIES: -:CUSTOM_ID: certbot -:END: If you want to serve Nextcloud from HTTPS rather than plain HTTP, use the following commands to issue Let's Encrypt SSL certificates: -#+begin_src sh +```sh sudo apt install snapd sudo snap install core sudo snap refresh core sudo snap install --classic certbot sudo ln -s /snap/bin/certbot /usr/bin/certbot sudo certbot --apache -#+end_src +``` + +## Results -** Results -:PROPERTIES: -:CUSTOM_ID: results -:END: Voilà! You're all done and should be able to access Nextcloud from your domain or IP address. See the screenshots below for the dashboard and a settings page on my -instance of Nextcloud, using the =Breeze Dark= theme I installed from -the Apps page. +instance of Nextcloud, using the `Breeze Dark` theme I +installed from the Apps page. -#+caption: Nextcloud Dashboard -[[https://img.cleberg.net/blog/20220323-installing-nextcloud-on-ubuntu/nextcloud_dashboard.png]] + -/Figure 01: Nextcloud Dashboard/ +*Figure 01: Nextcloud Dashboard* -#+caption: Nextcloud Settings -[[https://img.cleberg.net/blog/20220323-installing-nextcloud-on-ubuntu/nextcloud_settings.png]] + -/Figure 02: Nextcloud Security Settings/ +*Figure 02: Nextcloud Security Settings* diff --git a/content/blog/2022-03-24-server-hardening.md b/content/blog/2022-03-24-server-hardening.md new file mode 100644 index 0000000..90cb433 --- /dev/null +++ b/content/blog/2022-03-24-server-hardening.md @@ -0,0 +1,353 @@ ++++ +date = 2022-03-24 +title = "Hardening a Public-Facing Home Server" +description = "Learn some basic techniques to harden a home server and network." ++++ + +## Post Updates + +> After reviewing this post today (2022-10-04), I noticed quite a few +> gaps in my write-up and wanted to add a few things, even though this +> blog is really just a retrospective and knowledge dump for myself. I +> left things intact and simply crossed them out (~~like this~~) for +> posterity. + +## Planning Data Flows & Security + +### My Personal Data Flow + +```txt + ┌───────┐ ┌─────────────────┐ + ┌──► VLAN1 ├───► Private Devices │ + │ └───────┘ └─────────────────┘ +┌──────────┐ ┌────────┐ ┌──────────┐ ┌────────┐ │ +│ Internet ├───► Router ├───► Firewall ├───► Switch ├──┤ +└──────────┘ └────────┘ └──────────┘ └────────┘ │ + │ ┌───────┐ ┌───────────────┐ + └──► VLAN2 ├───► Public Server │ + └───────┘ └───────────────┘ +``` + +### Thought Process + +To serve content from your home server and harden your security posture, +you have to think about the transport of data from `server` +to `client`. + +Let's start with the actual server itself. Think about the following: + +- Do I have a firewall enabled? Do I need to update this to allow new + ports or IPs? +- Do I have an IPS/IDS that may prevent outside traffic? +- Do I have any other security software installed? +- Are the services hosted inside Docker containers, behind a reverse + proxy, or virtualized? If so, are they configured to allow outside + traffic? + +Once the data leaves the server, where does it go? In my case, it goes +to a managed switch. In this case, I asked the following: + +- What configurations is the switch using? +- Am I using VLANs? + - Yes, I am using 802.1Q VLANs. +- Are the VLANs configured properly? + - Yes, as shown in the [Switch](#switch) section below, I have a + separate VLAN to allow outside traffic to and from the server + alone. No other devices, except for a service port, and in that + VLAN. + +At this point, the data has been processed through the switch. Where +does it go next? In my case, it's pretty simple: it goes to the +router/modem device. + +- Does my ISP block any ports that I need? + - This is an important step that a lot of people run into when + self-hosting at home. Use an online port-checker tool for your + IP or call your ISP if you think ports are blocked. +- Is there a router firewall? + - Yes, I checked that it's configured to allow the ports I need + to run my services publicly. Common web servers and reverse + proxies require ports 80 and 443, but other services like media + servers or games can require unique ports, so be sure to check + the documentation for your service(s). +- Are there any other settings affecting inbound/outbound traffic? + - Schedules or access blocks + - Static Routing + - QoS + - Port Forwarding + - DMZ Hosting + - Remote Management (this can sometimes mess with services that + also require the use of ports 80 and 443) + +Once the data leaves my router, it goes to the upstream ISP and can be +accessed publicly. + +## Server + ++The services I run on my server are installed straight into the OS, +without any use of Docker or VMs, so I don't need any extra application +configuration to make them accessible to the outside world.+ + +As of 2022-10-04, the paragraph above is no longer true as I now run a +reverse proxy with Nginx and host many services inside Docker. However, +it doesn't change anything regarding this post as I still just need to +open ports 80 & 443 and create the necessary website configuration +files. + +When creating new services - either installed directly on bare metal or +within something like Docker - I ensure that I read through the +documentation thoroughly to understand a few key things: - What network +activities should this app perform (if any)? Using which ports and +protocols? - Does this app require any commands/services to be run as +`root`? - Does this app log errors, authentication +failures/successes, or anything else that would be useful for an +investigation? + +For extra security, I use limit all incoming connections to SSH +connections through my server firewall (`ufw`) and disable +common SSH settings. After all of that, I use `fail2ban` as a +preventative measure against brute-force login attempts. + +As another piece of security, you can randomize your SSH port to ensure +that random scanners or attackers can't easily try to force their way +into your network. For example, you can edit the port rules in your +server to block all connection requests to port `22` but +forward all remote connections from port `12345` to your +server's port `22`. Then you just need to SSH to your +network via your randomized port. + +### `ufw` + +To see how to configure `ufw`, see my other post: [Secure +Your Network with the Uncomplicated +Firewall](/blog/secure-your-network-with-the-uncomplicated-firewall/). + +The general notion with an on-device firewall is that you want to deny +all incoming connections by default and then selectively open certain +ports for services or users that you know need access. + +If you know that you will only be logging into this server from a +certain set or list of IPs, you can always set the firewall to only +allow connections to port 22 from those IPs. + +For a quick start to only allow SSH connections to the server, use this: + +```sh +sudo ufw default deny incoming +sudo ufw default allow outgoing +sudo ufw allow 22 +sudo ufw enable +``` + + + +### `ssh` + +1. Using SSH Keys + + First, make sure you have an SSH keypair generated on the device(s) + that you'll be using to log in to the server. If you don't have an + SSH key, run this command: + + ```sh + ssh-keygen + ``` + + Now that we have an SSH key, copy it to the server with the + following command, which will ask for the user's password before + accepting the key: + + ```sh + ssh-copy-id my_user@my_server + ``` + + If you have multiple keys, you'll need to specify which to use. + After it's complete, `ssh` back into the server as that + user and make sure it doesn't ask for a password. + +2. Disable Password & Root Authentication + + Now that we can access the server without a password, we will + disable password authentication and disable anyone from using + `ssh` to login as `root`. + + To do this, open the `sshd_config` file: + + ```sh + sudo nano /etc/ssh/sshd_config + ``` + + You'll need to update the parameters to the values below. If one of + these rules is commented-out or doesn't exist, create the rule at + the bottom of the file. + + ```config + PermitRootLogin no + PasswordAuthentication no + PubkeyAuthentication yes + ``` + + Finally, restart the `ssh` service: + + ```sh + sudo systemctl restart sshd.service + ``` + + To test that everything's working so far, open ANOTHER terminal and + try logging in as `root` over SSH. It is very important + that you keep your current SSH session open and test with an + additional session, or you will lock yourself out at some point and + will need to use a recovery method (e.g., hooking monitor up to home + server) to get yourself back in. + +3. Enable MFA for `ssh` + + This part is optional, but I highly recommend it. So far, we've + ensured that no one can log into our user on the server without + using our secret key, and we've ensured that no one can log in + remotely as `root`. Next, you can enable MFA + authentication for `ssh` connections. + + This process involves editing a couple files and installing an MFA + package, so I will not include all the details in this post. To see + how to configure MFA for `ssh`, see my other post: + [Enabling MFA for SSH](/blog/enable-totp-mfa-for-ssh/). + +  + +### `fail2ban` + +I haven't written a post on how I use `fail2ban`, but it's +quite simple. I use the default `sshd` jail, but you can +always create new jails for respective applications or ports. For +example, if you use Nginx as your web server, you can use the +`nginx-http-auth` jail. + +In order to get it up and running, use the following commands: + +```sh +sudo apt install fail2ban +sudo fail2ban-client start sshd +sudo fail2ban-client status sshd +``` + +This should be used as a last-resort defense and shouldn't be a +replacement for the security measures mentioned above. + + + +## Switch + +Between the router and any local devices is my managed switch, which is +used to create VLANs. The example below shows how I would isolate the +VLANs if I were starting to host a single service at home. + +### 802.1Q VLAN Configuration + +In this configuration, port 8 is the public server that needs to be +accessed from the outside. Port 23 is my 'dedicated service port' for +this server. In order to SSH to this server, I need to plug my laptop +into port 23 or else I cannot SSH. Otherwise, I'd need to hook up a +monitor and keyboard directly to the server to manage it. + + VLAN ID VLAN Name Member Ports Tagged Ports Untagged Ports + --------- ----------- -------------- -------------- ---------------- + 1 Default 1-24 1-24 + 2 Server 1,8,23 1,8,23 + +### 802.1Q VLAN PVID Setting + +Once the VLAN is created, I simply add the `VLAN ID` of +`2` as the `PVID` for any related ports (in this +case, see that ports `8` and `23` have a PVID of +`2`). + + Port PVID + ------ ------ + 1 1 + 2 1 + 3 1 + 4 1 + 5 1 + 6 1 + 7 1 + 8 2 + 9 1 + 10 1 + 11 1 + 12 1 + 13 1 + 14 1 + 15 1 + 16 1 + 17 1 + 18 1 + 19 1 + 20 1 + 21 1 + 22 1 + 23 2 + 24 1 + +## Router + +On my router, the configuration was as easy as opening the firewall +settings and unblocking the ports I needed for my services (e.g., +HTTP/S, Plex, SSH, MySQL, etc.). + ++Since I'm relying on an ISP-provided modem/router combo for now (not +by choice), I do not use any other advanced settings on my router that +would inhibit any valid traffic to these services.+ + +The paragraph above regarding the ISP-owned router is no longer accurate +as I now use the Ubiquiti Unifi Dream Machine Pro as my router. Within +this router, I enabled port forwarding/firewall rules, segregate the +network based on the device, and enable traffic restrictions (e.g., +silently drop traffic from certain countries and threat categories). + +If you have the option with your ISP, I recommend using a personal +router with software that you are familiar with so that you can explore +all the options available to you. + +## Physical Security + +One large piece of self-hosting that people generally don't discuss +online is physical security. However, physical security is very +important for everyone who hosts a server like this. Exactly *how* +important it is depends on the server use/purpose. + +If you self-host customer applications that hold protected data (HIPAA, +GDPR, COPPA, etc.), then physical security is extremely important and +cannot be ignored. If you simply host a blog and some hobby sites, then +it's a relatively minor consideration, but one you still need to think +about. + +### Location + +The first consideration is quite simple: location. - Is the server +within a property you own or housed on someone else's property? - Is it +nearby (in your house, in your work office, in your neighbor's garage, +in a storage unit, etc.)? - Do you have 24/7 access to the server? - Are +there climate considerations, such as humidity, fires, tornadoes, +monsoons? - Do you have emergency equipment nearby in case of emergency? + +### Hardware Ownership + +Secondly, consider the hardware itself: - Do you own the server in its +entirety? - Are any other users able to access the server, even if your +data/space is segregated? - If you're utilizing a third party, do they +have any documentation to show responsibility? This could be a SOC 1/2/3 +report, ISO compliance report, internal security/safety documentation. + +### Physical Controls + +Regardless of who owns the hardware, ensure that there are adequate +safeguards in place, if necessary. These usually don't apply to small +home servers and are usually covered already if you're utilizing a +third party. + +These can include: - Server bezel locks - Server room locks - physical, +digital, or biometric authentication - Security cameras - Raised +floors/lowered ceilings with proper guards/gates in-place within the +floors or ceilings - Security personnel - Log sheets and/or guest badges diff --git a/blog/2022-03-26-ssh-mfa.org b/content/blog/2022-03-26-ssh-mfa.md index 1d7141e..30b6a84 100644 --- a/blog/2022-03-26-ssh-mfa.org +++ b/content/blog/2022-03-26-ssh-mfa.md @@ -1,88 +1,83 @@ -#+title: Enable TOTP MFA for SSH -#+date: 2022-03-26 ++++ +date = 2022-03-26 +title = "Enable TOTP MFA for SSH" +description = "Learn how to enable timed one-time passcodes for SSH." ++++ + +## Why Do I Need MFA for SSH? -** Why Do I Need MFA for SSH? -:PROPERTIES: -:CUSTOM_ID: why-do-i-need-mfa-for-ssh -:END: If you are a sysadmin of a server anywhere (that includes at home!), you may want an added layer of protection against intruders. This is not a replacement for other security measures, such as: -- Disable root SSH -- Disable SSH password authentication -- Allow only certain users to login via SSH -- Allow SSH only from certain IPs +- Disable root SSH +- Disable SSH password authentication +- Allow only certain users to login via SSH +- Allow SSH only from certain IPs However, MFA can be added as an additional security measure to ensure that your server is protected. This is especially important if you need to allow password authentication for SSH. For more guidance on server security measures, see my other post: -[[/blog/hardening-a-public-facing-home-server/][Hardening a -Public-Facing Home Server]]. +[Hardening a Public-Facing Home +Server](/blog/hardening-a-public-facing-home-server/). + +## Install MFA PAM Module -** Install MFA PAM Module -:PROPERTIES: -:CUSTOM_ID: install-mfa-pam-module -:END: PAM, which stands for Pluggable Authentication Module, is an authentication infrastructure used on Linux systems to authenticate a user. In order to use this technology, let's install the -=libpam-google-authenticator= package: +`libpam-google-authenticator` package: -#+begin_src sh +```sh sudo apt-get update -#+end_src +``` -#+begin_src sh +```sh sudo apt-get install libpam-google-authenticator -#+end_src - -** Initialize the PAM Module -:PROPERTIES: -:CUSTOM_ID: initialize-the-pam-module -:END: -*** Interactive Method -:PROPERTIES: -:CUSTOM_ID: interactive-method -:END: +``` + +## Initialize the PAM Module + +### Interactive Method + Once the package is installed, initialize it and following the interactive prompts to generate your OTP or TOTP: -#+begin_src sh +```sh google-authenticator -#+end_src +``` If you are not sure how to answer, read the prompts carefully and think about having to how each situation would affect your normal login attempts. If you are still not sure, use my default responses below. -#+begin_src txt +```txt OUTPUT Do you want authentication tokens to be time-based (y/n) y -#+end_src +``` At this point, use an authenticator app somewhere one of your devices to scan the QR code. Any future login attempts after our upcoming configuration changes will require that TOTP. -#+begin_src txt +```txt OUTPUT Do you want me to update your "/home/user/.google_authenticator" file? (y/n) y -#+end_src +``` -#+begin_src txt +```txt OUTPUT Do you want to disallow multiple uses of the same authentication token? This restricts you to one login about every 30s, but it increases your chances to notice or even prevent man-in-the-middle attacks (y/n) y -#+end_src +``` -#+begin_src txt +```txt OUTPUT By default, a new token is generated every 30 seconds by the mobile app. @@ -95,32 +90,30 @@ code, the next code) to 17 permitted codes (the 8 previous codes, the current code, and the 8 next codes). This will permit for a time skew of up to 4 minutes between client and server. Do you want to do so? (y/n) n -#+end_src +``` -#+begin_src txt +```txt OUTPUT If the computer that you are logging into isn't hardened against brute-force login attempts, you can enable rate-limiting for the authentication module. By default, this limits attackers to no more than 3 login attempts every 30s. Do you want to enable rate-limiting? (y/n) y -#+end_src +``` + +### Non-Interactive Method -*** Non-Interactive Method -:PROPERTIES: -:CUSTOM_ID: non-interactive-method -:END: If you need to do this quickly, know your responses to the prompts, or are setting this up for numerous users, the non-interactive method can be much faster: -#+begin_src sh +```sh google-authenticator -t -d -f -r 3 -R 30 -w 3 -#+end_src +``` The options referenced above are as follows: -#+begin_src txt +```txt google-authenticator [<options>] -h, --help Print this message -c, --counter-based Set up counter-based (HOTP) verification @@ -140,69 +133,66 @@ google-authenticator [<options>] -w, --window-size=W Set window of concurrently valid codes -W, --minimal-window Disable window of concurrently valid codes -e, --emergency-codes=N Number of emergency codes to generate -#+end_src +``` This fully configures the authenticator, saves it to a file, and then outputs the secret key, QR code, and recovery codes. (If you add the -flag =-q=, then there won't be any output). If you use this command in -an automated fashion, make sure your script captures the secret key -and/or recovery codes and makes them available to the user. - -** PAM Configuration Settings -:PROPERTIES: -:CUSTOM_ID: pam-configuration-settings -:END: +flag `-q`, then there won't be any output). If you use this +command in an automated fashion, make sure your script captures the +secret key and/or recovery codes and makes them available to the user. + +## PAM Configuration Settings + Once you've enabled the T/OTP and have it saved to an MFA app on your -phone or other device, open the PAM =sshd= file: +phone or other device, open the PAM `sshd` file: -#+begin_src sh +```sh sudo nano /etc/pam.d/sshd -#+end_src +``` You need to do two things in this file. First, add the following lines to the bottom of the file: -#+begin_src config +```config auth required pam_google_authenticator.so nullok auth required pam_permit.so -#+end_src +``` Second, comment-out the following line near the top of the file. If you leave this line uncommented, every SSH login attempt will ask for the following three authentication factors: -1. Publickey -2. Password -3. T/OTP code +1. Publickey +2. Password +3. T/OTP code -#+begin_src config +```config #@include common-auth -#+end_src +``` + +## SSH Configuration Settings -** SSH Configuration Settings -:PROPERTIES: -:CUSTOM_ID: ssh-configuration-settings -:END: -Finally, edit the =sshd_config= file again: +Finally, edit the `sshd_config` file again: -#+begin_src sh +```sh sudo nano /etc/ssh/sshd_config -#+end_src +``` -You'll need to change =ChallengeResponseAuthentication= to yes and add -the =AuthenticationMethods= line to the bottom of the file. +You'll need to change `ChallengeResponseAuthentication` to +yes and add the `AuthenticationMethods` line to the bottom of +the file. -#+begin_src config +```config ChallengeResponseAuthentication yes AuthenticationMethods publickey,password publickey,keyboard-interactive -#+end_src +``` -Finally, restart the =ssh= service: +Finally, restart the `ssh` service: -#+begin_src sh +```sh sudo systemctl restart sshd.service -#+end_src +``` The next time you log in, you should be greeted with a verification code request! diff --git a/content/blog/2022-04-02-nginx-reverse-proxy.md b/content/blog/2022-04-02-nginx-reverse-proxy.md new file mode 100644 index 0000000..493dfd3 --- /dev/null +++ b/content/blog/2022-04-02-nginx-reverse-proxy.md @@ -0,0 +1,234 @@ ++++ +date = 2022-04-02 +title = "Set-Up a Reverse Proxy with Nginx" +description = "Learn how to set-up an Nginx reverse proxy from scratch." ++++ + +## What is a Reverse Proxy? + +A reverse proxy is a server that is placed between local servers or +services and clients/users (e.g., the internet). The reverse proxy +intercepts all requests from clients at the network edge and uses its +configuration files to determine where each request should be sent. + +### A Brief Example + +For example, let's say that I run three servers in my home: + +- Server~01~ (`example.com`) +- Server~02~ (`service01.example.com`) +- Server~03~ (`service02.example.com`) + +I also run a reverse proxy in my home that intercepts all public +traffic: + +- Reverse Proxy + +Assume that I have a domain name (`example.com`) that allows +clients to request websites or services from my home servers. + +In this case, the reverse proxy will intercept all traffic from +`example.com` that enters my network and determine if the +client is requesting valid data, based on my configuration. + +If the user is requesting `example.com` and my configuration +files say that Server~01~ holds that data, Nginx will send the user to +Server~01~. If I were to change the configuration so that +`example.com` is routed to Server~02~, that same user would +be sent to Server~02~ instead. + +```txt +┌──────┐ ┌───────────┐ +│ User │─┐ ┌──► Server_01 │ +└──────┘ │ │ └───────────┘ + │ ┌──────────┐ ┌───────────────┐ │ ┌───────────┐ + ├────► Internet ├───► Reverse Proxy ├─────├──► Server_02 │ + │ └──────────┘ └───────────────┘ │ └───────────┘ +┌──────┐ │ │ ┌───────────┐ +│ User │─┘ └──► Server_03 │ +└──────┘ └───────────┘ +``` + +## Reverse Proxy Options + +There are a lot of options when it comes to reverse proxy servers, so +I'm just going to list a few of the options I've heard recommended +over the last few years: + +- [Nginx](https://nginx.com) +- [Caddy](https://caddyserver.com) +- [Traefik](https://traefik.io/) +- [HAProxy](https://www.haproxy.org/) +- [Squid](https://ubuntu.com/server/docs/proxy-servers-squid) + +In this post, we will be using Nginx as our reverse proxy, running on +Ubuntu Server 20.04.4 LTS. + +## Nginx Reverse Proxy Example + +### Local Applications + +You may be like me and have a lot of applications running on your local +network that you'd like to expose publicly with a domain. + +In my case, I have services running in multiple Docker containers within +a single server and want a way to visit those services from anywhere +with a URL. For example, on my local network, [Dashy](https://dashy.to) +runs through port 4000 (`localhost:4000`) and [Uptime +Kuma](https://github.com/louislam/uptime-kuma) runs through port 3001 +(`localhost:3001`). + +In order to expose these services to the public, I will need to do the +following: + +1. Set up DNS records for a domain or subdomain (one per service) to + point toward the IP address of the server. +2. Open up the server network's HTTP and HTTPS ports (80 & 443) so + that the reverse proxy can accept traffic and determine where to + send it. +3. Install the reverse proxy software. +4. Configure the reverse proxy to recognize which service should get + traffic from any of the domains or subdomains. + +### Step 1: DNS Configuration + +To start, update your DNS configuration so that you have an +`A` record for each domain or subdomain. + +The `A` records should point toward the public IP address of +the server. If you don't know the public IP address, log in to the +server and run the following command: + +```sh +curl ifconfig.co +``` + +In the DNS example below, `xxx.xxx.xxx.xxx` is the public IP +address of the server. + +```config +example.com A xxx.xxx.xxx.xxx +uptime.example.com A xxx.xxx.xxx.xxx +dashy.example.com A xxx.xxx.xxx.xxx +www CNAME example.com +``` + +Finally, ensure the DNS has propagated correctly with [DNS +Checker](https://dnschecker.org) by entering your domains or subdomains +in the search box and ensuring the results are showing the correct IP +address. + +### Step 2: Open Network Ports + +This step will be different depending on which router you have in your +home. If you're not sure, try to visit +[192.168.1.1](http://192.168.1.1) in your browser. Login credentials are +usually written on a sticker somewhere on your modem/router. + +Once you're able to log in to your router, find the Port Forwarding +settings. You will need to forward ports `80` and +`443` to whichever machine is running the reverse proxy. + +In my case, the table below shows the port-forwarding rules I've +created. In this table, `xxx.xxx.xxx.xxx` is the local device +IP of the reverse proxy server, it will probably be an IP between +`192.168.1.1` and `192.168.1.255`. + + NAME FROM PORT DEST PORT/IP ENABLED + ------- ------ ------ ----------------- --------- + HTTP \* 80 xxx.xxx.xxx.xxx TRUE + HTTPS \* 443 xxx.xxx.xxx.xxx TRUE + +Once configured, these rules will direct all web traffic to your reverse +proxy. + +### Step 3: Nginx Installation + +To install Nginx, simply run the following command: + +```sh +sudo apt install nginx +``` + +If you have a firewall enabled, open up ports `80` and +`443` on your server so that Nginx can accept web traffic +from the router. + +For example, if you want to use `ufw` for web traffic and +SSH, run the following commands: + +```sh +sudo ufw allow 'Nginx Full' +sudo ufw allow SSH +sudo ufw enable +``` + +### Step 4: Nginx Configuration + +Now that we have domains pointing toward the server, the only step left +is to configure the reverse proxy to direct traffic from domains to +local services. + +To start, you'll need to create a configuration file for each domain in +`/etc/nginx/sites-available/`. They will look identical +except for the `server_name` variable and the +`proxy_pass` port. + +Dashy: + +```sh +nano /etc/nginx/sites-available/dashy.example.com +``` + +```config +server { + listen 80; + server_name dashy.example.com; + + location / { + proxy_pass http://localhost:4000; + } +} +``` + +Uptime: + +```sh +nano /etc/nginx/sites-available/uptime.example.com +``` + +```config +server { + listen 80; + server_name uptime.example.com; + + location / { + proxy_pass http://localhost:3001; + } +} +``` + +Once the configuration files are created, you will need to enable them +with the `symlink` command: + +```sh +sudo ln -s /etc/nginx/sites-available/dashy.example.com /etc/nginx/sites-enabled/ +``` + +Voilà! Your local services should now be available through their URLs. + +## HTTPS with Certbot + +If you've followed along, you'll notice that your services are only +available via HTTP (not HTTPS). + +If you want to enable HTTPS for your new domains, you will need to +generate SSL/TLS certificates for them. The easiest way to generate +certificates on Nginx is [Certbot](https://certbot.eff.org): + +```sh +sudo apt install snapd; sudo snap install core; sudo snap refresh core +sudo snap install --classic certbot +sudo ln -s /snap/bin/certbot /usr/bin/certbot +sudo certbot --nginx +``` diff --git a/blog/2022-04-09-pinetime.org b/content/blog/2022-04-09-pinetime.md index b0fc662..cbf3e8f 100644 --- a/blog/2022-04-09-pinetime.org +++ b/content/blog/2022-04-09-pinetime.md @@ -1,53 +1,44 @@ -#+title: PineTime: An Open-Source SmartWatch -#+date: 2022-04-09 - -** PineTime Product Information -:PROPERTIES: -:CUSTOM_ID: pinetime-product-information -:END: -*** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: -The [[https://www.pine64.org/pinetime/][PineTime]] is an open-source -smartwatch, created by [[https://www.pine64.org][PINE64]]. Originally ++++ +date = 2022-04-09 +title = "PineTime: An Open-Source Smart Watch" +description = "Playing with the PineTime smart watch." ++++ + +## PineTime Product Information + +### Overview + +The [PineTime](https://www.pine64.org/pinetime/) is an open-source +smartwatch, created by [PINE64](https://www.pine64.org). Originally announced in September 2019, this ARM-based watch is a fantastic option for users who want the benefits of a modern smartwatch with the backing of open-source components and software. -*** Product Specifications -:PROPERTIES: -:CUSTOM_ID: product-specifications -:END: -I won't dive into too many details that you can find on -[[https://www.pine64.org/pinetime/][the product page]], but I wanted to -point out the prices for each watch and the primary functions: - -**** Price: -:PROPERTIES: -:CUSTOM_ID: price -:END: -- $26.99 (Sealed) -- $24.99 (Dev Kit) -- $51.98 (One Sealed + One Dev Kit) - -**** Primary Functionality: -:PROPERTIES: -:CUSTOM_ID: primary-functionality -:END: -- Clock (+ Smartphone Sync) -- Pedometer -- Heart Rate Monitor -- Sleep Monitor -- Calories burned -- Messaging -- Smartphone Notifications -- Media Controls - -** Unboxing -:PROPERTIES: -:CUSTOM_ID: unboxing -:END: +### Product Specifications + +I won't dive into too many details that you can find on [the product +page](https://www.pine64.org/pinetime/), but I wanted to point out the +prices for each watch and the primary functions: + +1. Price: + + - \$26.99 (Sealed) + - \$24.99 (Dev Kit) + - \$51.98 (One Sealed + One Dev Kit) + +2. Primary Functionality: + + - Clock (+ Smartphone Sync) + - Pedometer + - Heart Rate Monitor + - Sleep Monitor + - Calories burned + - Messaging + - Smartphone Notifications + - Media Controls + +## Unboxing + Now, my PineTime was ordered on 2022-02-17, shipped on 2022-02-22, and was delivered on 2022-03-23. With the current delays on shipping times around the world (and the semiconductor shortage), a month for delivery @@ -60,35 +51,31 @@ USB wall adapter). The watch itself was able to turn on immediately when I pulled it out of the box, but the battery was depleted and required charging right away. -#+caption: PineTime Box Contents -[[https://img.cleberg.net/blog/20220409-pinetime-smart-watch/pinetime_box_contents.png]] - -** Software -:PROPERTIES: -:CUSTOM_ID: software -:END: -*** Watch OS: InfiniTime -:PROPERTIES: -:CUSTOM_ID: watch-os-infinitime -:END: + + +## Software + +### Watch OS: InfiniTime + While turning on the watch for the first time, some of the main design choices you can see in the watch OS, -[[https://wiki.pine64.org/wiki/InfiniTime][InfiniTime]], are: +[InfiniTime](https://wiki.pine64.org/wiki/InfiniTime), are: -- A square bezel, not too thin against the sides of the watch. -- A simple, rubber band. -- Basic font and screen pixel design. -- Swipe gestures to access other screens. +- A square bezel, not too thin against the sides of the watch. +- A simple, rubber band. +- Basic font and screen pixel design. +- Swipe gestures to access other screens. -#+caption: PineTime Screens -[[https://img.cleberg.net/blog/20220409-pinetime-smart-watch/pinetime.png]] + The OS itself is fantastic in terms of functionality for me. It does exactly what a smartwatch should do - track time, steps, heart rates, and connect to another smart device, without being overly burdensome to the user. -My only gripe so far is that it's /really/ difficult to swipe to +My only gripe so far is that it's *really* difficult to swipe to different screens, such as pulling down the notification tray. I'm not sure if this is an OS or hardware issue, but it makes it quite hard to quickly move around the screens. @@ -99,52 +86,46 @@ accidentally turn on the screen. With other watches, I absolutely hated not being able to turn off the raise-to-wake or wave features (i.e., blinding myself while wearing a watch at night because I moved my arm). -*** iOS App: InfiniLink -:PROPERTIES: -:CUSTOM_ID: ios-app-infinilink -:END: +### iOS App: InfiniLink + Since I am using iOS as my primary mobile device OS, I am using the -[[https://github.com/xan-m/InfiniLink][InfiniLink]] app to connect my +[InfiniLink](https://github.com/xan-m/InfiniLink) app to connect my watch. This app provides the following for PineTime owners: -- Firmware updates -- Steps -- Charts -- Notifications +- Firmware updates +- Steps +- Charts +- Notifications I mashed up a few screenshots to show off the home page, menu, firmware update, and notification test screens: -#+caption: InfiniLink Home -[[https://img.cleberg.net/blog/20220409-pinetime-smart-watch/infinilink_home.png]] + Another big feature of InfiniLink is the ability to track pedometer steps in a collection of beautiful graphs, with the option to change your step goal and add in manual steps. -#+caption: InfiniLink Steps -[[https://img.cleberg.net/blog/20220409-pinetime-smart-watch/infinilink_steps.png]] + Finally, there are charts to display the battery percentage and heart rates over time. This area also comes with an option to clear data. -#+caption: InfiniLink Charts -[[https://img.cleberg.net/blog/20220409-pinetime-smart-watch/infinilink_charts.png]] - -** Final Thoughts -:PROPERTIES: -:CUSTOM_ID: final-thoughts -:END: -*** Pros -:PROPERTIES: -:CUSTOM_ID: pros -:END: + + +## Final Thoughts + +### Pros + After wearing my watch for a few weeks, I have mostly positive thoughts about the watch so far. In the past, I have owned smartwatches by -FitBit, Fossil, Apple, etc. - *but I prefer the PineTime over all of -those watches*. +FitBit, Fossil, Apple, etc. - **but I prefer the PineTime over all of +those watches**. The PineTime strips out all the unnecessary features and performs the functions that it provides effectively and efficiently. @@ -152,14 +133,12 @@ functions that it provides effectively and efficiently. The battery life is amazing on this device. By default, the watch seems to last anywhere from a few days to a week before dying. -And of course, it's open source and backed by some of the most dedicated -enthusiasts and developers I've seen. Watching the Matrix channel, -forums, and website have been exciting to see. +And of course, it's open source and backed by some of the most +dedicated enthusiasts and developers I've seen. Watching the Matrix +channel, forums, and website have been exciting to see. + +### Cons -*** Cons -:PROPERTIES: -:CUSTOM_ID: cons -:END: If I had to complain about anything, it would simply be the small bugs in some features that can be contributed to the companion apps more than the watch itself. diff --git a/blog/2022-06-01-ditching-cloudflare.org b/content/blog/2022-06-01-ditching-cloudflare.md index df61114..9593632 100644 --- a/blog/2022-06-01-ditching-cloudflare.org +++ b/content/blog/2022-06-01-ditching-cloudflare.md @@ -1,10 +1,11 @@ -#+title: Ditching Cloudflare for Njalla -#+date: 2022-06-01 ++++ +date = 2022-06-01 +title = "Ditching Cloudflare for Njalla" +description = "A retrospective on my decision to leave Cloudflare and move to Njalla for domain registration and DNS." ++++ + +## Registrar -** Registrar -:PROPERTIES: -:CUSTOM_ID: registrar -:END: After spending a year or so using Cloudflare for DNS only - no proxying or applications - I spent the last few months using Cloudflare Tunnels and Cloudflare Access to protect my self-hosted websites and @@ -14,27 +15,22 @@ However, I have never liked using Cloudflare due to their increasingly large share of control over web traffic, as well as their business model of being a MITM for all of your traffic. -So, as of today, I have switched over to [[https://njal.la][Njalla]] as -my registrar and DNS manager. I was able to easily transfer my domains -over rapidly, with only one domain taking more than 15-30 minutes to +So, as of today, I have switched over to [Njalla](https://njal.la) as my +registrar and DNS manager. I was able to easily transfer my domains over +rapidly, with only one domain taking more than 15-30 minutes to propagate. +I do still have two domains sitting at Cloudflare for the moment while I decide if they're worth the higher rates (one domain is 30€ and the other is 45€).+ -#+begin_quote -*Update (2022.06.03)*: I ended up transferring my final two domains over -to Njalla, clearing my Cloudflare account of personal data, and deleting -the Cloudflare account entirely. /I actually feel relieved to have moved -on to a provider I trust./ +> **Update (2022.06.03)**: I ended up transferring my final two domains +> over to Njalla, clearing my Cloudflare account of personal data, and +> deleting the Cloudflare account entirely. *I actually feel relieved to +> have moved on to a provider I trust.* -#+end_quote +## DNS -** DNS -:PROPERTIES: -:CUSTOM_ID: dns -:END: As noted above, I'm using Njalla exclusively for DNS configurations on my domains. @@ -46,55 +42,48 @@ back in one-by-one. This would be much simpler if I were able to edit the plain-text format of the DNS configuration. I was able to do that at a past registrar -(perhaps it was [[https://gandi.net/][Gandi.net]]?) and it made life a -lot easier. - -*** Dynamic DNS Updates -:PROPERTIES: -:CUSTOM_ID: dynamic-dns-updates -:END: -I have built an easy Python script to run (or set-up in =cron= to run -automatically) that will check my server's IPv4 and IPv6, compare it to -Njalla, and update the DNS records if they don't match. You can see the -full script and process in my other post: -[[/blog/njalla-dns-api/][Updating Dynamic DNS with Njalla API]]. +(perhaps it was [Gandi.net](https://gandi.net/)?) and it made life a lot +easier. + +### Dynamic DNS Updates + +I have built an easy Python script to run (or set-up in +`cron` to run automatically) that will check my server's +IPv4 and IPv6, compare it to Njalla, and update the DNS records if they +don't match. You can see the full script and process in my other post: +[Updating Dynamic DNS with Njalla API](/blog/njalla-dns-api/). I haven't used this other method, but I do know that you can create -=Dynamic= DNS records with Njalla that -[[https://njal.la/docs/ddns/][work for updating dynamic subdomains]]. - -*** Njalla's DNS Tool -:PROPERTIES: -:CUSTOM_ID: njallas-dns-tool -:END: -One neat upside to Njalla is that they have a -[[https://check.njal.la/dns/][DNS lookup tool]] that provides a lot of -great information for those of you (AKA: me) who hate using the =dig= -command. +`Dynamic` DNS records with Njalla that [work for updating +dynamic subdomains](https://njal.la/docs/ddns/). + +### Njalla's DNS Tool + +One neat upside to Njalla is that they have a [DNS lookup +tool](https://check.njal.la/dns/) that provides a lot of great +information for those of you (AKA: me) who hate using the +`dig` command. This was very useful for monitoring a couple of my transferred domains to see when the changes in nameservers, records, and DNSSEC went into effect. -** Tunnel -:PROPERTIES: -:CUSTOM_ID: tunnel -:END: +## Tunnel + Cloudflare Tunnel is a service that acts as a reverse-proxy (hosted on Cloudflare's servers) and allowed me to mask the private IP address of the server hosting my various websites and apps. However, as I was moving away from Cloudflare, I was not able to find a suitable replacement that was both inexpensive and simple. So, I simply -went back to hosting [[/blog/set-up-nginx-reverse-proxy/][my own reverse -proxy with Nginx]]. With the recent additions of Unifi hardware in my -server/network rack, I am much more protected against spam and malicious -attacks at the network edge than I was before I switched to Cloudflare. - -** Access -:PROPERTIES: -:CUSTOM_ID: access -:END: +went back to hosting [my own reverse proxy with +Nginx](/blog/set-up-nginx-reverse-proxy/). With the recent +additions of Unifi hardware in my server/network rack, I am much more +protected against spam and malicious attacks at the network edge than I +was before I switched to Cloudflare. + +## Access + Cloudflare Access, another app I used in combination with Cloudflare Tunnel, provided an authentication screen that required you to enter valid credentials before Cloudflare would forward you to the actual diff --git a/blog/2022-06-04-njalla-dns-api.org b/content/blog/2022-06-04-njalla-dns-api.md index d6a74d6..34fb680 100644 --- a/blog/2022-06-04-njalla-dns-api.org +++ b/content/blog/2022-06-04-njalla-dns-api.md @@ -1,14 +1,15 @@ -#+title: Dynamic DNS with Njalla API -#+date: 2022-06-04 - -** Njalla's API -:PROPERTIES: -:CUSTOM_ID: njallas-api -:END: -As noted in my recent post about [[/blog/ditching-cloudflare/][switching -to Njalla from Cloudflare]], I was searching for a way to replace my -very easy-to-use bash script to [[/blog/cloudflare-dns-api/][update -Cloudflare's DNS via their API]]. ++++ +date = 2022-02-10 +title = "Dynamic DNS with Njalla API" +description = "Learn how to dynamically update DNS records for changing IPs with Njalla." ++++ + +## Njalla's API + +As noted in my recent post about [switching to Njalla from +Cloudflare](/blog/ditching-cloudflare/), I was searching for a +way to replace my very easy-to-use bash script to [update Cloudflare's +DNS via their API](/blog/cloudflare-dns-api/). To reiterate what I said in those posts, this is a common necessity for those of us who have non-static IP addresses that can change at any @@ -21,93 +22,88 @@ update their domain's DNS records if it changes. This post explains how to use Python to update Njalla's DNS records whenever a machine's public IP address changes. -*** Creating a Token -:PROPERTIES: -:CUSTOM_ID: creating-a-token -:END: +### Creating a Token + To use Njalla's API, you will first need to create a token that will be used to authenticate you every time you call the API. Luckily, this is very easy to do if you have an account with Njalla. -Simply go the [[https://njal.la/settings/api/][API Settings]] page and -click the =Add Token= button. Next, enter a name for the token and click -=Add=. +Simply go the [API Settings](https://njal.la/settings/api/) page and +click the `Add Token` button. Next, enter a name for the +token and click `Add`. -Finally, click the =Manage= button next to your newly created token and -copy the =API Token= field. +Finally, click the `Manage` button next to your newly created +token and copy the `API Token` field. + +### Finding the Correct API Request -*** Finding the Correct API Request -:PROPERTIES: -:CUSTOM_ID: finding-the-correct-api-request -:END: Once you have a token, you're ready to call the Njalla API for any number of requests. For a full listing of available requests, see the -[[https://njal.la/api/][Njalla API Documentation]]. +[Njalla API Documentation](https://njal.la/api/). -For this demo, we are using the =list-records= and =edit-record= -requests. +For this demo, we are using the `list-records` and +`edit-record` requests. -The =list-records= request requires the following payload to be sent -when calling the API: +The `list-records` request requires the following payload to +be sent when calling the API: -#+begin_src txt +```txt params: { domain: string } -#+end_src +``` -The =edit-record= request requires the following payload to be sent when -calling the API: +The `edit-record` request requires the following payload to +be sent when calling the API: -#+begin_src txt +```txt params: { domain: string id: int content: string } -#+end_src +``` + +## Server Set-Up -** Server Set-Up -:PROPERTIES: -:CUSTOM_ID: server-set-up -:END: To create this script, we will be using Python. By default, I use Python 3 on my servers, so please note that I did not test this in Python 2, and I do not know if Python 2 will work for this. -*** Creating the Script -:PROPERTIES: -:CUSTOM_ID: creating-the-script -:END: +### Creating the Script + First, find a suitable place to create your script. Personally, I just -create a directory called =ddns= in my home directory: +create a directory called `ddns` in my home directory: -#+begin_src sh +```sh mkdir ~/ddns -#+end_src +``` Next, create a Python script file: -#+begin_src sh +```sh nano ~/ddns/ddns.py -#+end_src +``` The following code snippet is quite long, so I won't go into depth on each part. However, I suggest you read through the entire script before running it; it is quite simple and contains comments to help explain each code block. -:warning: *Note*: You will need to update the following variables for +:warning: **Note**: You will need to update the following variables for this to work: -- =token=: This is the Njalla API token you created earlier. -- =user_domain=: This is the top-level domain you want to modify. -- =include_subdomains=: Set this to =True= if you also want to modify - subdomains found under the TLD. -- =subdomains=: If =include_subdomains= = =True=, you can include your - list of subdomains to be modified here. - -#+begin_src python +- `token`: This is the Njalla API token you created + earlier. +- `user_domain`: This is the top-level domain you want to + modify. +- `include_subdomains`: Set this to `True` if + you also want to modify subdomains found under the TLD. +- `subdomains`: If `include_subdomains` = + `True`, you can include your list of subdomains to be + modified here. + +```python #!/usr/bin/python # -*- coding: utf-8 -*- # Import Python modules @@ -173,7 +169,7 @@ for record in data['records']: ) else: print('IPv4 of', ipv4, - 'does not match Njalla\'s value of', + 'does not match Njalla's value of', record['content'], '. Updating...') update_record(user_domain, record['id'], ipv4) elif record['type'] == 'AAAA': @@ -183,36 +179,33 @@ for record in data['records']: ) else: print('IPv6 of', ipv6, - 'does not match Njalla\'s value of', + 'does not match Njalla's value of', record['content'], '. Updating...') update_record(user_domain, record['id'], ipv6) -#+end_src +``` + +### Running the Script -*** Running the Script -:PROPERTIES: -:CUSTOM_ID: running-the-script -:END: Once you've created the script and are ready to test it, run the following command: -#+begin_src sh +```sh python3 ~/ddns/ddns.py -#+end_src +``` + +### Setting the Script to Run Automatically -*** Setting the Script to Run Automatically -:PROPERTIES: -:CUSTOM_ID: setting-the-script-to-run-automatically -:END: -To make sure the scripts run automatically, add it to the =cron= file so -that it will run on a schedule. To do this, open the =cron= file: +To make sure the scripts run automatically, add it to the +`cron` file so that it will run on a schedule. To do this, +open the `cron` file: -#+begin_src sh +```sh crontab -e -#+end_src +``` In the cron file, paste the following at the bottom of the editor in order to check the IP every five minutes: -#+begin_src sh +```sh */5 * * * * python3 /home/<your_username>/ddns/ddns.py -#+end_src +``` diff --git a/blog/2022-06-07-freshrss.org b/content/blog/2022-06-07-freshrss.md index 653e5a3..5a17c0d 100644 --- a/blog/2022-06-07-freshrss.org +++ b/content/blog/2022-06-07-freshrss.md @@ -1,10 +1,11 @@ -#+title: Self-Hosting FreshRSS -#+date: 2022-06-07 ++++ +date = 2022-06-07 +title = "Self-Hosting FreshRSS" +description = "A guide to self-hosting the FreshRSS application on your own server." ++++ + +## Why RSS? -** Why RSS? -:PROPERTIES: -:CUSTOM_ID: why-rss -:END: After noticing that I have collected 50+ blogs as bookmarks, I decided to migrate back to using RSS feeds to stay up-to-date with my favorite websites. Using RSS allows me to read all of these posts in a single app @@ -15,61 +16,56 @@ However, I ran into one issue: syncing subscriptions and read/unread posts across devices. Since I want to be able to easily read on both mobile and desktop, I decided to look for a self-hosted RSS solution. -Thus, I found [[https://www.freshrss.org/][FreshRSS]] and was able to +Thus, I found [FreshRSS](https://www.freshrss.org/) and was able to successfully install it on my server in about 30 minutes. -** Documentation -:PROPERTIES: -:CUSTOM_ID: documentation -:END: -While it's certainly not robust, the -[[https://freshrss.github.io/FreshRSS/][FreshRSS documentation]] is -helpful for figuring out basic information about the service. +## Documentation + +While it's certainly not robust, the [FreshRSS +documentation](https://freshrss.github.io/FreshRSS/) is helpful for +figuring out basic information about the service. However, I wanted to install this service as a Docker container and -stumbled across the -[[https://github.com/FreshRSS/FreshRSS/tree/edge/Docker][Docker README]] -within the GitHub repository. +stumbled across the [Docker +README](https://github.com/FreshRSS/FreshRSS/tree/edge/Docker) within +the GitHub repository. This README was the documentation I actually needed. However, as you'll -see below, I still had to manually edit one file (=config.php=) to -access the API externally via my RSS apps. - -** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: -*** DNS -:PROPERTIES: -:CUSTOM_ID: dns -:END: +see below, I still had to manually edit one file +(`config.php`) to access the API externally via my RSS apps. + +## Installation + +### DNS + The first step, as required by any external web service, was assigning a -domain name to use. I chose to use a subdomain, like =rss.example.com=. +domain name to use. I chose to use a subdomain, like +`rss.example.com`. -To assign this, I created an =A= record in my DNS settings with the IPv4 -address of the server and an =AAAA= record with the IPv6 address of the -server. Note: assigning an IPv6 (=AAAA=) record is optional, but I like -to enable IPV6 for my services. +To assign this, I created an `A` record in my DNS settings +with the IPv4 address of the server and an `AAAA` record with +the IPv6 address of the server. Note: assigning an IPv6 +(`AAAA`) record is optional, but I like to enable IPV6 for my +services. -#+begin_src config +```config rss.example.com A xxx.xxx.xxx.xxx rss.example.com AAAA xxxx:xxxx: ... :xxxx -#+end_src - -*** Docker -:PROPERTIES: -:CUSTOM_ID: docker -:END: -I initially tried to set up a =docker-compose.yml= file with a =.env= -file because I prefer to have a file I can look back at later to see how -I initially started the container, but it simply wouldn't work for me. -I'm not sure why, but I assume I wasn't telling =docker-compose= where -the =.env= file was. - -Regardless, I chose to simply run the service with =docker run=. See the -following command for my =docker run= configuration: - -#+begin_src sh +``` + +### Docker + +I initially tried to set up a `docker-compose.yml` file with +a `.env` file because I prefer to have a file I can look back +at later to see how I initially started the container, but it simply +wouldn't work for me. I'm not sure why, but I assume I wasn't telling +`docker-compose` where the `.env` file was. + +Regardless, I chose to simply run the service with +`docker run`. See the following command for my +`docker run` configuration: + +```sh sudo docker run -d --restart unless-stopped --log-opt max-size=10m \ -p 8080:80 \ -e TZ=America/Chicago \ @@ -78,46 +74,44 @@ sudo docker run -d --restart unless-stopped --log-opt max-size=10m \ -v freshrss_extensions:/var/www/FreshRSS/extensions \ --name freshrss \ freshrss/freshrss -#+end_src +``` This started the container successfully and allowed me to visit the -FreshRSS instance at =localhost:8080=. +FreshRSS instance at `localhost:8080`. + +### Fresh RSS Set-Up -*** Fresh RSS Set-Up -:PROPERTIES: -:CUSTOM_ID: fresh-rss-set-up -:END: -I *HIGHLY* suggest that you set up your user account prior to exposing +I **HIGHLY** suggest that you set up your user account prior to exposing this service to the public. It's unlikely that someone is trying to -access the exact domain or IP/port you're assigning here, but as soon as -you expose this service, the first person to open the URL will be able -to create the admin user. +access the exact domain or IP/port you're assigning here, but as soon +as you expose this service, the first person to open the URL will be +able to create the admin user. -In order to set up your FreshRSS service, open the =localhost:8080= URL -in your browser (you may need to use a local IP instead of =localhost= -if you're accessing the page from a different machine on the network - -e.g., =192.168.1.20:8080=). +In order to set up your FreshRSS service, open the +`localhost:8080` URL in your browser (you may need to use a +local IP instead of `localhost` if you're accessing the page +from a different machine on the network - e.g., +`192.168.1.20:8080`). Once the page loads, set up your default user with a strong username and password. You may also choose to configure other settings prior to exposing this service. -*** Nginx Reverse-Proxy -:PROPERTIES: -:CUSTOM_ID: nginx-reverse-proxy -:END: +### Nginx Reverse-Proxy + In order to access this service outside my home, I needed to set up a -reverse-proxy to connect =localhost:8080= to =rss.example.com=. +reverse-proxy to connect `localhost:8080` to +`rss.example.com`. First, I created a new Nginx configuration file: -#+begin_src sh +```sh sudo nano /etc/nginx/sites-available/rss.example.com -#+end_src +``` Within the config file, I pasted the following code: -#+begin_src config +```config upstream freshrss { server 127.0.0.1:8080; keepalive 64; @@ -146,91 +140,87 @@ server { proxy_pass_header Authorization; } } -#+end_src +``` Finally, restart Nginx and you will be able to access your service via HTTP: -#+begin_src sh +```sh sudo systemctl restart nginx.service -#+end_src +``` + +### HTTPS -*** HTTPS -:PROPERTIES: -:CUSTOM_ID: https -:END: However, I don't want to access my RSS feeds via HTTP. I want it available only via HTTPS. In order to do this, I ran the -[[https://certbot.eff.org/][certbot]] program to generate SSL -certificates for me: +[certbot](https://certbot.eff.org/) program to generate SSL certificates +for me: -#+begin_src sh +```sh sudo certbot --nginx -#+end_src +``` This process will automatically generate an SSL certificate for you and modify the Nginx configuration file to include a redirect from HTTP to HTTPS. -** Post-Installation Fixes -:PROPERTIES: -:CUSTOM_ID: post-installation-fixes -:END: +## Post-Installation Fixes + At this point, we have a functional FreshRSS website, available from anywhere and secured with HTTPS. However, attempting to connect this service to an RSS app resulted in many errors regarding unavailable URLs and incorrect credentials. -*** API Set-Up -:PROPERTIES: -:CUSTOM_ID: api-set-up -:END: -First, you need to open your user profile in FreshRSS (=Settings= > -=Profile=) and set an API password in the field at the bottom. This is -the password you will need to provide to your RSS apps. +### API Set-Up + +First, you need to open your user profile in FreshRSS +(`Settings` > `Profile`) and set an API password +in the field at the bottom. This is the password you will need to +provide to your RSS apps. Once that is set and saved, click the link below the API password field to open the API check tool. It should look something like -=https://localhost:8080/api/= or =https://rss.example.com/api/=. +`https://localhost:8080/api/` or +`https://rss.example.com/api/`. -Within this page, you /should/ see your correct external URL and "PASS" -at the bottom of each API type. This would mean everything is set up -correctly, and you can now move on and login to any RSS apps that +Within this page, you *should* see your correct external URL and +"PASS" at the bottom of each API type. This would mean everything is +set up correctly, and you can now move on and login to any RSS apps that support self-hosted options. In my case, the URL showed an internal URL and I had a warning that the -=base_url= variable may be misconfigured. If this is the case, see the -next section for a fix. +`base_url` variable may be misconfigured. If this is the +case, see the next section for a fix. + +### Base URL Fix -*** Base URL Fix -:PROPERTIES: -:CUSTOM_ID: base-url-fix -:END: -In order to fix the =base_url= for the API, I opened up my docker -container with the following command: +In order to fix the `base_url` for the API, I opened up my +docker container with the following command: -#+begin_src sh +```sh sudo docker exec -it freshrss bash -#+end_src +``` Within this container, update the packages and install an editor: -#+begin_src sh +```sh apt-get update apt-get install nano -#+end_src +``` -Finally, open up =config.php= in the =data= directory: +Finally, open up `config.php` in the `data` +directory: -#+begin_src sh +```sh nano data/config.php -#+end_src +``` -Within =config.php=, you will need to update the =base_url= variable and -update it to match your external URL. In my case, I simply commented-out -the incorrect URL with =//= and added the correct one on a new line: +Within `config.php`, you will need to update the +`base_url` variable and update it to match your external URL. +In my case, I simply commented-out the incorrect URL with +`//` and added the correct one on a new line: -#+begin_src php +```php <?php return array ( ... @@ -239,25 +229,26 @@ the incorrect URL with =//= and added the correct one on a new line: ... ) > -#+end_src +``` -You can now exit the file with =Ctrl + x=, press =y= to save the file, -and then click =Enter= to keep the same file name. +You can now exit the file with `Ctrl + x`, press +`y` to save the file, and then click `Enter` to +keep the same file name. Finally, just exit out of the docker container: -#+begin_src sh +```sh exit -#+end_src +``` Next, just restart the container: -#+begin_src sh +```sh sudo docker restart freshrss -#+end_src +``` Voilà! Your API check should now "PASS" and you should be able to use one of the API URLs in your RSS apps. -In my case, I use [[https://netnewswire.com][NetNewsWire]] on my desktop +In my case, I use [NetNewsWire](https://netnewswire.com) on my desktop and phone. diff --git a/blog/2022-06-16-terminal-lifestyle.org b/content/blog/2022-06-16-terminal-lifestyle.md index 4056415..7b9eb32 100644 --- a/blog/2022-06-16-terminal-lifestyle.org +++ b/content/blog/2022-06-16-terminal-lifestyle.md @@ -1,24 +1,25 @@ -#+title: A Terminal Lifestyle -#+date: 2022-06-16 ++++ +date = 2022-06-16 +title = "A Terminal Lifestyle" +description = "Explaining how I live my digital life mostly in the console/terminal." ++++ + +## Text-Based Simplicity -** Text-Based Simplicity -:PROPERTIES: -:CUSTOM_ID: text-based-simplicity -:END: I've detailed my views on web-based minimalism and related topics in other posts throughout the years; e.g., JavaScript/CSS bloat slowing down websites that are essentially a text document. However, I have never really expanded beyond talking about the web and describing how I focus on minimizing distractions in other digital environments. -This post is going to set the baseline for how I /try/ to live my +This post is going to set the baseline for how I *try* to live my digital life. It does not necessarily get into my physical life, which is often harder to control and contain all the noise in our modern world. While there are new things to do every day in our digital world, I find that keeping a core set of values and interests can ground you and keep -you mindful of /why/ you are participating in the digital world. For +you mindful of *why* you are participating in the digital world. For example, if - at your core - you have no interest in what strangers think about random topics, it would be unwise to start participating in social media. However, I am someone who has been dragged in by effective @@ -29,14 +30,12 @@ I won't dive much further into explaining the philosophy of all this, but I will link a few helpful articles that may pique your interest if you're in search of more meaningful experiences: -- [[https://en.wikipedia.org/wiki/Mindfulness][Mindfulness]] -- [[https://en.wikipedia.org/wiki/Minimalism][Minimalism]] -- [[https://en.wikipedia.org/wiki/Stoicism][Stoicism]] +- [Mindfulness](https://en.wikipedia.org/wiki/Mindfulness) +- [Minimalism](https://en.wikipedia.org/wiki/Minimalism) +- [Stoicism](https://en.wikipedia.org/wiki/Stoicism) + +## Living Life in the Terminal -** Living Life in the Terminal -:PROPERTIES: -:CUSTOM_ID: living-life-in-the-terminal -:END: My personal approach to reducing digital distractions and increasing my focus on the task at hand is to use a terminal for as much as I possibly can. @@ -44,12 +43,12 @@ can. Most days, this means that I have a few tabs open constantly in my terminal: -1. A web browser -2. A chat client -3. An email client -4. An RSS feed reader -5. A local shell for navigating my computer's files -6. A remote shell for managing servers and other machines +1. A web browser +2. A chat client +3. An email client +4. An RSS feed reader +5. A local shell for navigating my computer's files +6. A remote shell for managing servers and other machines Beyond this, I rarely open other tabs or GUI applications, unless absolutely necessary. If you look, you may be surprised what can be @@ -58,61 +57,56 @@ accomplished in the terminal. For example, I have moved my music and entertainment downloads to the terminal, along with my device VPN connections. I am exploring options for moving my RSS subscriptions to something like -[[https://newsboat.org/][Newsboat]], so that I can read my daily -articles without all the fuss. +[Newsboat](https://newsboat.org/), so that I can read my daily articles +without all the fuss. Now that we have some examples out of the way, let's dive into the specifics. -*** Browsing the Web -:PROPERTIES: -:CUSTOM_ID: browsing-the-web -:END: -I'm going to start off with a hard topic for those who prefer to live in -the terminal: web browsing. This task is made hard mostly by websites +### Browsing the Web + +I'm going to start off with a hard topic for those who prefer to live +in the terminal: web browsing. This task is made hard mostly by websites and web apps that require JavaScript to run. The other difficult part is -that if you're using a text-based browser, that means images won't load -(hopefully that's obvious). +that if you're using a text-based browser, that means images won't +load (hopefully that's obvious). -I am using [[https://lynx.invisible-island.net][Lynx]], a text-based +I am using [Lynx](https://lynx.invisible-island.net), a text-based browser that runs quickly and easily in the terminal. Lynx allows me to -browser most websites by simply typing =g= and then typing in the URL I -want. +browser most websites by simply typing `g` and then typing in +the URL I want. -#+caption: Lynx -[[https://img.cleberg.net/blog/20220616-terminal-lifestyle/lynx.png]] + -If you need a search engine while in Lynx, I recommend -[[https://lite.duckduckgo.com/lite/][DuckDuckGo (Lite)]], which allows -you to search the web using their text-only interface. +If you need a search engine while in Lynx, I recommend [DuckDuckGo +(Lite)](https://lite.duckduckgo.com/lite/), which allows you to search +the web using their text-only interface. -#+caption: DuckDuckGo !Lite -[[https://img.cleberg.net/blog/20220616-terminal-lifestyle/ddg.png]] + Eventually, you will run into websites that don't work (or are just too -ugly and messy) in a text-only mode, and you'll be forced to switch over -to a GUI browser to look at that site. Personally, I don't mind this as -it doesn't happen as often as I thought it would. +ugly and messy) in a text-only mode, and you'll be forced to switch +over to a GUI browser to look at that site. Personally, I don't mind +this as it doesn't happen as often as I thought it would. The only time I need to do this is when I want to browse an image/video-focused webpage or if I need to log in to a site, and it -doesn't support a text-only login page. For example, I am able to easily -log in to [[https://sr.ht][Sourcehut]] in lynx. +doesn't support a text-only login page. For example, I am able to +easily log in to [Sourcehut](https://sr.ht) in lynx. + +### Chatting with Friends -*** Chatting with Friends -:PROPERTIES: -:CUSTOM_ID: chatting-with-friends -:END: After web browsing activities, my main form of terminal communication is -Matrix. I use the [[https://docs.mau.fi/gomuks/][gomuks]] client +Matrix. I use the [gomuks](https://docs.mau.fi/gomuks/) client currently. This was incredibly easy to install on macOS (but I will need to see if it'll be just as easy on Linux when my new laptop arrives): -#+begin_src sh +```sh brew install gomuks -#+end_src +``` Once you launch gomuks, it will sync and require your username and password to login. After doing so, the only problem I ran into was @@ -120,111 +114,102 @@ verifying my gomuks client so that I could participate in rooms with E2EE. Finally, I was able to verify the session by opening the Element desktop -app (I assume you can do this in the browser and mobile app too, but I'm -not sure) and manually verifying myself with this process: +app (I assume you can do this in the browser and mobile app too, but +I'm not sure) and manually verifying myself with this process: -1. Open the Element desktop app -2. Open a room I was a member of -3. Open the =Room Info= pane -4. Open the =People= menu and search for myself -5. Click on my profile name -6. Click on the session link under the =Security= section and follow the - prompts to manually verify the session +1. Open the Element desktop app +2. Open a room I was a member of +3. Open the `Room Info` pane +4. Open the `People` menu and search for myself +5. Click on my profile name +6. Click on the session link under the `Security` section + and follow the prompts to manually verify the session Overall, I like gomuks and am able to enjoy all the features I was using in Element. The only hiccup I have occurred is manually downloading images to view them, which can be annoying. -#+caption: gomuks -[[https://img.cleberg.net/blog/20220616-terminal-lifestyle/gomuks.png]] + + +### Email -*** Email -:PROPERTIES: -:CUSTOM_ID: email -:END: Moving email to the terminal has been the hardest of the tasks for me. Unlike web browsing, where I can simply decide to not look at a website that does not work in the terminal, I cannot simply ignore emails sent to me. -Personally, I am experimenting with [[https://neomutt.org/][neomutt]] as -a potential email client. +Personally, I am experimenting with [neomutt](https://neomutt.org/) as a +potential email client. -However, this requires a *TON* of configuration and tweaking to get +However, this requires a **TON** of configuration and tweaking to get right. Even when I was able to set up neomutt, configure my email account, and customize a few personal preferences, a lot of emails still do not display correctly (mostly due to HTML and images). -I won't get into the details of configuring =neomutt=; I mostly followed -this blog post: -[[https://gideonwolfe.com/posts/workflow/neomutt/intro/][Email in the -Terminal: Configuring Neomutt]]. +I won't get into the details of configuring `neomutt`; I +mostly followed this blog post: [Email in the Terminal: Configuring +Neomutt](https://gideonwolfe.com/posts/workflow/neomutt/intro/). Finally, I have yet to figure out how to connect my GPG keys to -=neomutt=, but that's a problem for another day. +`neomutt`, but that's a problem for another day. + +### RSS Feed Reader -*** RSS Feed Reader -:PROPERTIES: -:CUSTOM_ID: rss-feed-reader -:END: -I have just started using [[https://newsboat.org/][Newsboat]] to read +I have just started using [Newsboat](https://newsboat.org/) to read articles in my terminal and have found quick success with it. I'll show you a quick screenshot first: -#+caption: Newsboat -[[https://img.cleberg.net/blog/20220616-terminal-lifestyle/newsboat.png]] + The configuration was super easy for this app; I simply installed the app, created a file for URLs, and imported my OPML subscriptions that I had exported out of my old feed reader: -#+begin_src sh +```sh brew install newsboat -#+end_src +``` -#+begin_src sh +```sh touch ~/.newsboat/urls -#+end_src +``` -#+begin_src sh +```sh newsboat -i=my_subscriptions.opml -#+end_src +``` + +### Writing & Programming -*** Writing & Programming -:PROPERTIES: -:CUSTOM_ID: writing-programming -:END: Unfortunately, the weak link in my terminal-based environment right now is my grasp of the possibilities of editing files within a shell. I am used to the easy extensions found in VSCodium and Kate, so I am slowly learning how to mold the default editing tools to my needs. -Currently, this means I am using =nano= with the following +Currently, this means I am using `nano` with the following configuration: -#+begin_src config +```config set breaklonglines set autoindent set linenumbers set tabstospaces set tabsize 2 set fill 80 -#+end_src +``` This configuration allows nano to automatically hard-wrap lines at 80 characters, autoindent the wrapped lines (if the previous line was indented), use 2 spaces per tab, and display line numbers within each file I open. -I am currently looking to see if =vim= or =emacs= would be more useful -for my current needs, but I'm not in any rush, so I don't expect to find -an answer anytime soon. +I am currently looking to see if `vim` or `emacs` +would be more useful for my current needs, but I'm not in any rush, so +I don't expect to find an answer anytime soon. With my current life demands, I am not programming at the moment and have not explored the best terminal set-up for programming. However, I -have seen many peers find success configuring =vim= and =emacs=, so -that's where I will start when I pick my projects back up. +have seen many peers find success configuring `vim` and +`emacs`, so that's where I will start when I pick my +projects back up. -#+caption: nano -[[https://img.cleberg.net/blog/20220616-terminal-lifestyle/nano.png]] + diff --git a/blog/2022-06-22-daily-poetry.org b/content/blog/2022-06-22-daily-poetry.md index dd1e249..cded214 100644 --- a/blog/2022-06-22-daily-poetry.org +++ b/content/blog/2022-06-22-daily-poetry.md @@ -1,18 +1,17 @@ -#+title: Daily Plaintext Poetry via Email -#+date: 2022-06-22 ++++ +date = 2022-06-22 +title = "Daily Plaintext Poetry via Email" +description = "A small project to automatically deliver poetry to your inbox daily." ++++ + +## Source Code -** Source Code -:PROPERTIES: -:CUSTOM_ID: source-code -:END: I don't want to bury the lede here, so if you'd like to see the full source code I use to email myself plaintext poems daily, visit the -repository: [[https://git.sr.ht/~cmc/daily-poem/][daily-poem]]. +repository: [daily-poem](https://git.sr.ht/~cmc/daily-poem/). + +## My Daily Dose of Poetry -** My Daily Dose of Poetry -:PROPERTIES: -:CUSTOM_ID: my-daily-dose-of-poetry -:END: Most of my programming projects are small, random projects that are made strictly to fix some small problem I have or enhance my quality of life. @@ -26,55 +25,47 @@ each morning, as I know I would simply give up and stop reading daily. Thus, I found a way to deliver poetry to myself in plain-text format, on a daily basis, and scheduled to deliver automatically. -** Prerequisites -:PROPERTIES: -:CUSTOM_ID: prerequisites -:END: +## Prerequisites + This solution uses Python and email, so the following process requires the following to be installed: -1. An SMTP server, which can be as easy as installing =mailutils= if - you're on a Debian-based distro. -2. Python (& pip!) -3. The following Python packages: =email=, =smtplib=, =json=, and - =requests= +1. An SMTP server, which can be as easy as installing + `mailutils` if you're on a Debian-based distro. +2. Python (& pip!) +3. The following Python packages: `email`, + `smtplib`, `json`, and `requests` + +## Breaking Down the Logic -** Breaking Down the Logic -:PROPERTIES: -:CUSTOM_ID: breaking-down-the-logic -:END: I want to break down the logic for this program, as it's quite simple and informational. -*** Required Packages -:PROPERTIES: -:CUSTOM_ID: required-packages -:END: +### Required Packages + This program starts with a simple import of the required packages, so I wanted to explain why each package is used: -#+begin_src py +```python from email.mime.text import MIMEText # Required for translating MIMEText import smtplib # Required to process the SMTP mail delivery import json # Required to parse the poetry API results import requests # Required to send out a request to the API -#+end_src +``` + +### Sending the API Request -*** Sending the API Request -:PROPERTIES: -:CUSTOM_ID: sending-the-api-request -:END: Next, we need to actually send the API request. In my case, I'm calling a random poem from the entire API. If you want, you can call specific poems or authors from this API. -#+begin_src py +```python json_data = requests.get('https://poetrydb.org/random').json() -#+end_src +``` This gives us the following result in JSON: -#+begin_src json +```json [ { "title": "Sonnet XXII: With Fools and Children", @@ -100,46 +91,40 @@ This gives us the following result in JSON: "linecount": "15" } ] -#+end_src +``` -*** Parsing the API Results -:PROPERTIES: -:CUSTOM_ID: parsing-the-api-results -:END: -In order to parse this into a readable format, we need to use the =json= -package and extract the fields we want. In the example below, I am -grabbing every field presented by the API. - -For the actual poem content, we need to loop over each line in the -=lines= variable since each line is a separate string by default. +### Parsing the API Results -#+begin_quote -You /could/ also extract the title or author and make another call out -to the API to avoid having to build the plaintext poem with a loop, but -it just doesn't make sense to me to send multiple requests when we can -create a simple loop on our local machine to work with the data we -already have. +In order to parse this into a readable format, we need to use the +`json` package and extract the fields we want. In the example +below, I am grabbing every field presented by the API. -For -[[https://poetrydb.org/title/Sonnet%20XXII:%20With%20Fools%20and%20Children/lines.text][example]], -look at the raw data response of this link to see the poem's lines -returned in plaintext. - -#+end_quote - -#+begin_src py +For the actual poem content, we need to loop over each line in the +`lines` variable since each line is a separate string by +default. + +> You *could* also extract the title or author and make another call out +> to the API to avoid having to build the plaintext poem with a loop, +> but it just doesn't make sense to me to send multiple requests when +> we can create a simple loop on our local machine to work with the data +> we already have. +> +> For +> [example](https://poetrydb.org/title/Sonnet%20XXII:%20With%20Fools%20and%20Children/lines.text), +> look at the raw data response of this link to see the poem's lines +> returned in plaintext. + +```python title = json_data[0]['title'] author = json_data[0]['author'] line_count = json_data[0]['linecount'] lines = '' for line in json_data[0]['lines']: lines = lines + line + "\n" -#+end_src +``` + +### Composing the Email -*** Composing the Email -:PROPERTIES: -:CUSTOM_ID: composing-the-email -:END: Now that I have all the data I need, I just need to compose it into a message and prepare the message metadata. @@ -148,47 +133,43 @@ by the author, then a blank line, and finally the full poem. This code snippet combines that data and packages it into a MIMEText container, ready to be emailed. -#+begin_src py +```python msg_body = title + "\n" + author + "\n\n" + lines msg = MIMEText(msg_body) -#+end_src +``` Before we send the email, we need to prepare the metadata (subject, from, to, etc.): -#+begin_src py +```python sender_email = 'example@server.local' recipient_emails = ['user@example.com'] msg['Subject'] = 'Your Daily Poem (' + line_count + ' lines)' msg['From'] = sender_email msg['To'] = recipient_email -#+end_src +``` + +### Sending the Email -*** Sending the Email -:PROPERTIES: -:CUSTOM_ID: sending-the-email -:END: Now that I have everything ready to be emailed, the last step is to simply connect to an SMTP server and send the email out to the -recipients. In my case, I installed =mailutils= on Ubuntu and let my -SMTP server be =localhost=. +recipients. In my case, I installed `mailutils` on Ubuntu and +let my SMTP server be `localhost`. -#+begin_src py +```python smtp_server = 'localhost' s = smtplib.SMTP(smtp_server) s.sendmail(sender_email, recipient_emails, msg.as_string()) s.quit() -#+end_src +``` + +## The Result! -** The Result! -:PROPERTIES: -:CUSTOM_ID: the-result -:END: -Instead of including a screenshot, I've copied the contents of the email -that was delivered to my inbox below since I set this process up in -plaintext format. +Instead of including a screenshot, I've copied the contents of the +email that was delivered to my inbox below since I set this process up +in plaintext format. -#+begin_src txt +```txt Date: Wed, 22 Jun 2022 14:37:19 +0000 (UTC) From: REDACTED To: REDACTED @@ -214,26 +195,25 @@ You that behold us, laugh us not to scorn; Give Nature thanks you are not such as we. Yet fools and children sometimes tell in play Some, wise in show, more fools indeed than they. -#+end_src +``` + +## Scheduling the Daily Email -** Scheduling the Daily Email -:PROPERTIES: -:CUSTOM_ID: scheduling-the-daily-email -:END: -Last, but not least, is scheduling this Python script with =crontab=. To -schedule a script to run daily, you can add it to the =crontab= file. To -do this, open =crontab= in editing mode: +Last, but not least, is scheduling this Python script with +`crontab`. To schedule a script to run daily, you can add it +to the `crontab` file. To do this, open `crontab` +in editing mode: -#+begin_src sh +```sh crontab -e -#+end_src +``` In the file, simply paste the following snippet at the bottom of the file and ensure that the file path is correctly pointing to wherever you saved your Python script: -#+begin_src config +```config 0 8 * * * python3 /home/<your_user>/dailypoem/main.py -#+end_src +``` We have now set up the script and scheduled it to run daily at 08:00! diff --git a/content/blog/2022-06-24-fedora-i3.md b/content/blog/2022-06-24-fedora-i3.md new file mode 100644 index 0000000..39afe3f --- /dev/null +++ b/content/blog/2022-06-24-fedora-i3.md @@ -0,0 +1,158 @@ ++++ +date = 2022-06-24 +title = "Rebooting My Love Affair with Linux" +description = "A retrospective on moving from macOS to Linux." ++++ + +## Leaving macOS + +As I noted [in a recent post](/blog/foss-macos-apps), I have been +planning on migrating from macOS back to a Linux-based OS. I am happy to +say that I have finally completed my migration and am now stuck in the +wonderful world of Linux again. + +My decision to leave macOS really came down to just a few important +things: + +- Apple Security (Gatekeeper) restricting me from running any software + I want. Even if you disable Gatekeeper and allow software to bypass + the rest of the device installation security, you still have to + repeat that process every time the allowed software is updated. +- macOS sends out nearly constant connections, pings, telemetry, etc. + to a myriad of mysterious Apple services. I'm not even going to + dive into how many macOS apps have constant telemetry on, as well. +- Lastly, I just *really* missed the customization and freedom that + comes with Linux. Being able to switch to entirely new kernel, OS, + or desktop within minutes is a freedom I took for granted when I + switched to macOS. + +Now that I've covered macOS, I'm going to move on to more exciting +topics: my personal choice of OS, DE, and various customizations I'm +using. + +## Fedora + +After trying a ton of distros (I think I booted and tested around 20-25 +distros), I finally landed on [Fedora Linux](https://getfedora.org/). I +have quite a bit of experience with Fedora and enjoy the +`dnf` package manager. Fedora allows me to keep up-to-date +with recent software (I'm looking at you, Debian), but still provides a +level of stability you don't find in every distro. + +In a very close second place was Arch Linux, as well as its spin-off: +Garuda Linux (Garuda w/ sway is *beautiful*). Arch is great for +compatibility and the massive community it has, but I have just never +had the time to properly sit down and learn the methodology behind their +packaging systems. + +Basically, everything else I tested was unacceptable in at least one way +or another. Void (`glibc`) was great, but doesn't support +all the software I need. Slackware worked well as a tui, but I wasn't +skilled enough to get a tiling window manager (WM) working on it. + +### i3 + +One of the reasons I settled on Fedora is that it comes with an official +i3 spin. Being able to use a tiling WM, such as i3 or sway, is one of +the biggest things I wanted to do as soon as I adopted Linux again. + +I will probably set up a dotfile repository soon, so that I don't lose +any of my configurations, but nothing big has been configured thus far. + +The two main things I have updated in i3wm are natural scrolling and +binding my brightness keys to the `brightnessctl` program. + +1. Natural Scrolling + + You can enable natural scrolling by opening the following file: + + ```sh + sudo nano /usr/share/X11/xorg.conf.d/40-libinput.conf + ``` + + Within the `40-libinput.conf` file, find the following + input sections and enable the natural scrolling option. + + This is the `pointer` section: + + ```conf + Section "InputClass" + Identifier "libinput pointer catchall" + MatchIsPointer "on" + MatchDevicePath "/dev/input/event*" + Driver "libinput" + Option "NaturalScrolling" "True" + EndSection + ``` + + This is the `touchpad` section: + + ```conf + Section "InputClass" + Identifier "libinput touchpad catchall" + MatchIsTouchpad "on" + MatchDevicePath "/dev/input/event*" + Driver "libinput" + Option "NaturalScrolling" "True" + EndSection + ``` + +2. Enabling Brightness Keys + + Likewise, enabling brightness key functionality is as simple as + binding the keys to the `brightnessctl` program. + + To do this, open up your i3 config file. Mine is located here: + + ```sh + nano /home/<my-user>/.config/i3/config + ``` + + ```conf + # Use brightnessctl to adjust brightness. + bindsym XF86MonBrightnessDown exec --no-startup-id brightnessctl --min-val=2 -q set 3%- + bindsym XF86MonBrightnessUp exec --no-startup-id brightnessctl -q set 3%+ + ``` + +3. `polybar` + + Instead of using the default `i3status` bar, I have opted + to use `polybar` instead (as you can also see in the + screenshot above). + + My config for this menu bar is basically just the default settings + with modified colors and an added battery block to quickly show me + the machine's battery info. + +4. `alacritty` + + Not much to say on this part yet, as I haven't configured it much, + but I installed `alacritty` as my default terminal, and I + am using `zsh` and the shell. + +## Software Choices + +Again, I'm not going to say much that I haven't said yet in other blog +posts, so I'll just do a quick rundown of the apps I installed +immediately after I set up the environment. + +Flatpak Apps: + +- Cryptomator +- pCloud +- Signal + +Fedora Packages: + +- gomuks +- neomutt +- neofetch +- Firefox + - uBlock Origin + - Bitwarden + - Stylus + - Privacy Redirect + +Other: + +- exiftool diff --git a/content/blog/2022-07-01-git-server.md b/content/blog/2022-07-01-git-server.md new file mode 100644 index 0000000..7e4b3f7 --- /dev/null +++ b/content/blog/2022-07-01-git-server.md @@ -0,0 +1,654 @@ ++++ +date = 2022-07-01 +title = "Self-Hosting a Personal Git Server" +description = "A guide to self-hosting a Git server on your own server." ++++ + +## My Approach to Self-Hosting Git + +I have often tried to self-host my Git repositories, but have always +fallen short when I tried to find a suitable web interface to show on +the front-end. + +After a few years, I have finally found a combination of methods that +allow me to easily self-host my projects, view them on the web, and +access them from anywhere. + +Before I dive into the details, I want to state a high-level summary of +my self-hosted Git approach: + +- This method uses the `ssh://` (read & write) and + `git://` (read-only) protocols for push and pull access. + - For the `git://` protocol, I create a + `git-daemon-export-ok` file in any repository that I + want to be cloneable by anyone. + - The web interface I am using (`cgit`) allows simple + HTTP cloning by default. I do not disable this setting as I want + beginners to be able to clone one of my repositories even if + they don't know the proper method. +- I am not enabling Smart HTTPS for any repositories. Updates to + repositories must be pushed via SSH. +- Beyond the actual repository management, I am using + `cgit` for the front-end web interface. + - If you use the `scan-path=<path>` configuration in + the `cgitrc` configuration file to automatically find + repositories, you can't exclude a repository from + `cgit` if it's stored within the path that + `cgit` reads. To host private repositories, you'd + need to set up another directory that `cgit` can't + read. + +## Assumptions + +For the purposes of this walkthrough, I am assuming you have a URL +(`git.example.com`) or IP address +(`207.84.26.991`) addressed to the server that you will be +using to host your git repositories. + +## Adding a Git User + +In order to use the SSH method associated with git, we will need to add +a user named `git`. If you have used the SSH method for other +git hosting sites, you are probably used to the following syntax: + +```sh +git clone [user@]server:project.git +``` + +The syntax above is an `scp`-like syntax for using SSH on the +`git` user on the server to access your repository. + +Let's delete any remnants of an old `git` user, if any, and +create the new user account: + +```sh +sudo deluser --remove-home git +sudo adduser git +``` + +### Import Your SSH Keys to the Git User + +Once the `git` user is created, you will need to copy your +public SSH key on your local development machine to the `git` +user on the server. + +If you don't have an SSH key yet, create one with this command: + +```sh +ssh-keygen +``` + +Once you create the key pair, the public should be saved to +`~/.ssh/id_rsa.pub`. + +If your server still has password-based authentication available, you +can copy it over to your user's home directory like this: + +```sh +ssh-copy-id git@server +``` + +Otherwise, copy it over to any user that you can access. + +```sh +scp ~/.ssh/id_rsa.pub your_user@your_server: +``` + +Once on the server, you will need to copy the contents into the +`git` user's `authorized_keys` file: + +```sh +cat id_rsa.pub > /home/git/.ssh/authorized_keys +``` + +### (Optional) Disable Password-Based SSH + +If you want to lock down your server and ensure that no one can +authenticate in via SSH with a password, you will need to edit your SSH +configuration. + +```sh +sudo nano /etc/ssh/sshd_config +``` + +Within this file, find the following settings and set them to the values +I am showing below: + +```conf +PermitRootLogin no +PasswordAuthentication no +AuthenticationMethods publickey +``` + +You may have other Authentication Methods required in your personal +set-up, so the key here is just to ensure that +`AuthenticationMethods` does not allow passwords. + +## Setting up the Base Directory + +Now that we have set up a `git` user to handle all transport +methods, we need to set up the directory that we will be using as our +base of all repositories. + +In my case, I am using `/git` as my source folder. To create +this folder and assign it to the user we created, execute the following +commands: + +```sh +sudo mkdir /git +sudo chown -R git:git /git +``` + +## Creating a Test Repository + +On your server, switch over to the `git` user in order to +start managing git files. + +```sh +su git +``` + +Once logged-in as the `git` user, go to your base directory +and create a test repository. + +```sh +cd /git +mkdir test.git && cd test.git +git init --bare +``` + +If you want to make this repo viewable/cloneable to the public via the +`git://` protocol, you need to create a +`git-daemon-export-ok` file inside the repository. + +```sh +touch git-daemon-export-ok +``` + +## Change the Login Shell for `git` + +To make sure that the `git` user is only used for git +operations and nothing else, you need to change the user's login shell. +To do this, simply use the `chsh` command: + +```sh +sudo chsh git +``` + +The interactive prompt will ask which shell you want the +`git` user to use. You must use the following value: + +```sh +/usr/bin/git-shell +``` + +Once done, no one will be able to SSH to the `git` user or +execute commands other than the standard git commands. + +## Opening the Firewall + +Don't forget to open up ports on the device firewall and network +firewall if you want to access these repositories publicly. If you're +using default ports, forward ports `22` (ssh) and +`9418` (git) from your router to your server's IP address. + +If your server also has a firewall, ensure that the firewall allows the +same ports that are forwarded from the router. For example, if you use +`ufw`: + +```sh +sudo ufw allow 22 +sudo ufw allow 9418 +``` + +### Non-Standard SSH Ports + +If you use a non-standard port for SSH, such as `9876`, you +will need to create an SSH configuration file on your local development +machine in order to connect to your server's git repositories. + +To do this, you'll need to define your custom port on your client +machine in your `~/.ssh/config` file: + +```sh +nano ~/.ssh/config +``` + +```conf +Host git.example.com + # HostName can be a URL or an IP address + HostName git.example.com + Port 9876 + User git +``` + +### Testing SSH + +There are two main syntaxes you can use to manage git over SSH: + +- `git clone [user@]server:project.git` +- `git clone ssh://[user@]server/project.git` + +I prefer the first, which is an `scp`-like syntax. To test +it, try to clone the test repository you set up on the server: + +```sh +git clone git@git.example.com:/git/test.git +``` + +## Enabling Read-Only Access + +If you want people to be able to clone any repository where you've +placed a `git-daemon-export-ok` file, you will need to start +the git daemon. + +To do this on a system with `systemd`, create a service file: + +```sh +sudo nano /etc/systemd/system/git-daemon.service +``` + +Inside the `git-daemon.service` file, paste the following: + +```conf +[Unit] +Description=Start Git Daemon + +[Service] +ExecStart=/usr/bin/git daemon --reuseaddr --base-path=/git/ /git/ + +Restart=always +RestartSec=500ms + +StandardOutput=syslog +StandardError=syslog +SyslogIdentifier=git-daemon + +User=git +Group=git + +[Install] +WantedBy=multi-user.target +``` + +Once created, enable and start the service: + +```sh +sudo systemctl enable git-daemon.service +sudo systemctl start git-daemon.service +``` + +To clone read-only via the `git://` protocol, you can use the +following syntax: + +```sh +git clone git://git.example.com/test.git +``` + +## Migrating Repositories + +At this point, we have a working git server that works with both SSH and +read-only access. + +For each of the repositories I had hosted a different provider, I +executed the following commands in order to place a copy on my server as +my new source of truth: + +Server: + +```sh +su git +mkdir /git/<REPOSITORY_NAME>.git && cd /git/<REPOSITORY_NAME>.git +git init --bare + +# If you want to make this repo viewable/cloneable to the public +touch git-daemon-export-ok +``` + +Client: + +```sh +git clone git@<PREVIOUS_HOST>:<REPOSITORY_NAME> +git remote set-url origin git@git.EXAMPLE.COM:/git/<REPOSITORY_NAME>.git +git push +``` + +## Optional Web View: `cgit` + +If you want a web viewer for your repositories, you can use various +tools, such as `gitweb`, `cgit`, or +`klaus`. I chose `cgit` due to its simple +interface and fairly easy set-up (compared to others). Not to mention +that the [Linux kernel uses `cgit`](https://git.kernel.org/). + +### Docker Compose + +Instead of using my previous method of using a `docker run` +command, I've updated this section to use `docker-compose` +instead for an easier installation and simpler management and +configuration. + +In order to use Docker Compose, you will set up a +`docker-compose.yml` file to automatically connect resources +like the repositories, `cgitrc`, and various files or folders +to the `cgit` container you're creating: + +```sh +mkdir ~/cgit && cd ~/cgit +nano docker-compose.yml +``` + +```conf +# docker-compose.yml +version: '3' + +services: + cgit: + image: invokr/cgit + volumes: + - /git:/git + - ./cgitrc:/etc/cgitrc + - ./logo.png:/var/www/htdocs/cgit/logo.png + - ./favicon.png:/var/www/htdocs/cgit/favicon.png + - ./filters:/var/www/htdocs/cgit/filters + ports: + - "8763:80" + restart: always +``` + +Then, just start the container: + +```sh +sudo docker-compose up -d +``` + +Once it's finished installing, you can access the site at +`<SERVER_IP>:8763` or use a reverse-proxy service to forward +`cgit` to a URL, such as `git.example.com`. See +the next section for more details on reverse proxying a URL to a local +port. + +### Nginx Reverse Proxy + +I am using Nginx as my reverse proxy so that the `cgit` +Docker container can use `git.example.com` as its URL. To do +so, I simply created the following configuration file: + +```sh +sudo nano /etc/nginx/sites-available/git.example.com +``` + +```conf +server { + listen 80; + server_name git.example.com; + + if ($host = git.example.com) { + return 301 https://$host$request_uri; + } + + return 404; +} + +server { + server_name git.example.com; + listen 443 ssl http2; + + location / { + # The final `/` is important. + proxy_pass http://localhost:8763/; + add_header X-Frame-Options SAMEORIGIN; + add_header X-XSS-Protection "1; mode=block"; + proxy_redirect off; + proxy_buffering off; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-Port $server_port; + } + + # INCLUDE ANY SSL CERTS HERE + include /etc/letsencrypt/options-ssl-nginx.conf; + ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; +} +``` + +Once created, symlink it and restart the web server. + +```sh +sudo ln -s /etc/nginx/sites-available/git.example.com /etc/nginx/sites-enabled/ +sudo systemctl restart nginx.service +``` + +As we can see below, my site at `git.example.com` is +available and running: + +### Settings Up Git Details + +Once you have `cgit` running, you can add some small details, +such as repository owners and descriptions by editing the following +files within each repository. + +Alternatively, you can use the `cgitrc` file to edit these +details if you only care to edit them for the purpose of seeing them on +your website. + +The `description` file within the repository on your server +will display the description online. + +```sh +cd /git/example.git +nano description +``` + +You can add a `[gitweb]` block to the `config` +file in order to display the owner of the repository. + +```sh +cd /git/example.git +nano config +``` + +```conf +[gitweb] + owner = "YourName" +``` + +Note that you can ignore the configuration within each repository and +simply set up this information in the `cgitrc` file, if you +want to do it that way. + +### Editing `cgit` + +In order to edit certain items within `cgit`, you need to +edit the `cgitrc` file. + +```sh +nano ~/cgit/cgitrc +``` + +Below is an example configuration for `cgitrc`. You can find +all the configuration options within the [configuration manual] +(<https://git.zx2c4.com/cgit/plain/cgitrc.5.txt>). + +```conf +css=/cgit.css +logo=/logo.png +favicon=/favicon.png +robots=noindex, nofollow + +enable-index-links=1 +enable-commit-graph=1 +enable-blame=1 +enable-log-filecount=1 +enable-log-linecount=1 +enable-git-config=1 + +clone-url=git://git.example.com/$CGIT_REPO_URL ssh://git@git.example.com:/git/$CGIT_REPO_URL + +root-title=My Git Website +root-desc=My personal git repositories. + +# Allow download of tar.gz, tar.bz2 and zip-files +snapshots=tar.gz tar.bz2 zip + +## +## List of common mimetypes +## +mimetype.gif=image/gif +mimetype.html=text/html +mimetype.jpg=image/jpeg +mimetype.jpeg=image/jpeg +mimetype.pdf=application/pdf +mimetype.png=image/png +mimetype.svg=image/svg+xml + +# Highlight source code +# source-filter=/var/www/htdocs/cgit/filters/syntax-highlighting.sh +source-filter=/var/www/htdocs/cgit/filters/syntax-highlighting.py + +# Format markdown, restructuredtext, manpages, text files, and html files +# through the right converters +about-filter=/var/www/htdocs/cgit/filters/about-formatting.sh + +## +## Search for these files in the root of the default branch of repositories +## for coming up with the about page: +## +readme=:README.md +readme=:readme.md +readme=:README.mkd +readme=:readme.mkd +readme=:README.rst +readme=:readme.rst +readme=:README.html +readme=:readme.html +readme=:README.htm +readme=:readme.htm +readme=:README.txt +readme=:readme.txt +readme=:README +readme=:readme + +# Repositories + +# Uncomment the following line to scan a path instead of adding repositories manually +# scan-path=/git + +## Test Section +section=git/test-section + +repo.url=test.git +repo.path=/git/test.git +repo.readme=:README.md +repo.owner=John Doe +repo.desc=An example repository! +``` + +### Final Fixes: Syntax Highlighting & README Rendering + +After completing my initial install and playing around with it for a few +days, I noticed two issues: + +1. Syntax highlighting did not work when viewing the source code within + a file. +2. The `about` tab within a repository was not rendered to + HTML. + +The following process fixes these issues. To start, let's go to the +`cgit` directory where we were editing our configuration file +earlier. + +```sh +cd ~/cgit +``` + +In here, create two folders that will hold our syntax files: + +```sh +mkdir filters && mkdir filters/html-converters && cd filters +``` + +Next, download the default filters: + +```sh +curl https://git.zx2c4.com/cgit/plain/filters/about-formatting.sh > about-formatting.sh +chmod 755 about-formatting.sh +curl https://git.zx2c4.com/cgit/plain/filters/syntax-highlighting.py > syntax-highlighting.py +chmod 755 syntax-highlighting.py +``` + +Finally, download the HTML conversion files you need. The example below +downloads the Markdown converter: + +```sh +cd html-converters +curl https://git.zx2c4.com/cgit/plain/filters/html-converters/md2html > md2html +chmod 755 md2html +``` + +If you need other filters or html-converters found within [the cgit +project files](https://git.zx2c4.com/cgit/tree/filters), repeat the +`curl` and `chmod` process above for whichever +files you need. + +However, formatting will not work quite yet since the Docker cgit +container we're using doesn't have the formatting package installed. +You can install this easily by install Python 3+ and the +`pygments` package: + +```sh +# Enter the container's command line +sudo docker exec -it cgit bash +``` + +```sh +# Install the necessary packages and then exit +yum update -y && \ +yum upgrade -y && \ +yum install python3 python3-pip -y && \ +pip3 install markdown pygments && \ +exit +``` + +**You will need to enter the cgit docker container and re-run these +`yum` commands every time you kill and restart the +container!** + +If not done already, we need to add the following variables to our +`cgitrc` file in order for `cgit` to know where +our filtering files are: + +```conf +# Highlight source code with python pygments-based highlighter +source-filter=/var/www/htdocs/cgit/filters/syntax-highlighting.py + +# Format markdown, restructuredtext, manpages, text files, and html files +# through the right converters +about-filter=/var/www/htdocs/cgit/filters/about-formatting.sh +``` + +Now you should see that syntax highlighting and README rendering to the +`about` tab is fixed. + +### Theming + +I won't go into much detail in this section, but you can fully theme +your installation of `cgit` since you have access to the +`cgit.css` file in your web root. This is another file you +can add as a volume to the `docker-compose.yml` file if you +want to edit this without entering the container's command line. + +## :warning: Remember to Back Up Your Data! + +The last thing to note is that running services on your own equipment +means that you're assuming a level of risk that exists regarding data +loss, catastrophes, etc. In order to reduce the impact of any such +occurrence, I suggest backing up your data regularly. + +Backups can be automated via `cron`, by hooking your base +directory up to a cloud provider, or even setting up hooks to push all +repository info to git mirrors on other git hosts. Whatever the method, +make sure that your data doesn't vanish in the event that your drives +or servers fail. diff --git a/blog/2022-07-14-gnupg.org b/content/blog/2022-07-14-gnupg.md index 66aee7c..229e1c6 100644 --- a/blog/2022-07-14-gnupg.org +++ b/content/blog/2022-07-14-gnupg.md @@ -1,31 +1,30 @@ -#+title: GNU Privacy Guard (GPG) -#+date: 2022-07-14 - -** The History of GPG -:PROPERTIES: -:CUSTOM_ID: the-history-of-gpg -:END: -[[https://gnupg.org/][GNU Privacy Guard]], also known as GnuPG and GPG, -is a free ("free" as in both speech and beer) software that fully -implements the OpenPGP Message Format documented in -[[https://www.rfc-editor.org/rfc/rfc4880][RFC 4880]]. ++++ +date = 2022-07-14 +title = "GNU Privacy Guard (GPG)" +description = "Learn how to create a PGP key with GNU Privacy Guard (GPG)." ++++ + +## The History of GPG + +[GNU Privacy Guard](https://gnupg.org/), also known as GnuPG and GPG, is +a free ("free" as in both speech and beer) software that fully +implements the OpenPGP Message Format documented in [RFC +4880](https://www.rfc-editor.org/rfc/rfc4880). I won't go in-depth on the full history of the software in this post, but it is important to understand that GPG is not the same as PGP (Pretty Good Privacy), which is a different implementation of RFC 4880. However, GPG was designed to interoperate with PGP. -GPG was originally developed in the late 1990s by -[[https://en.wikipedia.org/wiki/Werner_Koch][Werner Koch]] and has -historically been funded generously by the German government. +GPG was originally developed in the late 1990s by [Werner +Koch](https://en.wikipedia.org/wiki/Werner_Koch) and has historically +been funded generously by the German government. + +Now that we have all the high-level info out of the way, let's dive +into the different aspects of GPG and its uses. -Now that we have all the high-level info out of the way, let's dive into -the different aspects of GPG and its uses. +## Encryption Algorithms -** Encryption Algorithms -:PROPERTIES: -:CUSTOM_ID: encryption-algorithms -:END: GPG supports a wide range of different encryption algorithms, including public-key, cipher, hash, and compression algorithms. The support for these algorithms has grown since the adoption of the Libgcrypt library @@ -35,7 +34,7 @@ As you will be able to see below in an example of a full key generation with the GPG command line tool, GPG recommends the following algorithms to new users: -#+begin_src sh +```sh Please select what kind of key you want: (1) RSA and RSA (2) DSA and Elgamal @@ -43,75 +42,72 @@ Please select what kind of key you want: (4) RSA (sign only) (9) ECC (sign and encrypt) *default* (10) ECC (sign only) -#+end_src +``` I am not doing an in-depth explanation here in order to keep the focus on GPG and not encryption algorithms. If you want a deep dive into cryptography or encryption algorithms, please read my other posts: -- [[/blog/aes-encryption/][AES Encryption]] (2018) -- [[/blog/cryptography-basics/][Cryptography Basics]] (2020) +- [AES Encryption](/blog/aes-encryption/) (2018) +- [Cryptography Basics](/blog/cryptography-basics/) (2020) + +### Vulnerabilities -*** Vulnerabilities -:PROPERTIES: -:CUSTOM_ID: vulnerabilities -:END: As of 2022-07-14, there are a few different vulnerabilities associated with GPG or the libraries it uses: -- GPG versions 1.0.2--1.2.3 contains a bug where "as soon as one - (GPG-generated) ElGamal signature of an arbitrary message is released, - one can recover the signer's private key in less than a second on a - PC." ([[https://www.di.ens.fr/~pnguyen/pub_Ng04.htm][Source]]) -- GPG versions prior to 1.4.2.1 contain a false positive signature - verification bug. - ([[https://lists.gnupg.%20org/pipermail/gnupg-announce/2006q1/000211.html][Source]]) -- GPG versions prior to 1.4.2.2 cannot detect injection of unsigned - data. ( - [[https://lists.gnupg.org/pipermail/gnupg-announce/2006q1/000218.html][Source]]) -- Libgcrypt, a library used by GPG, contained a bug which enabled full - key recovery for RSA-1024 and some RSA-2048 keys. This was resolved in - a GPG update in 2017. ([[https://lwn.net/Articles/727179/][Source]]) -- The [[https://en.wikipedia.org/wiki/ROCA_vulnerability][ROCA - Vulnerability]] affects RSA keys generated by YubiKey 4 tokens. - ([[https://crocs.fi.%20muni.cz/_media/public/papers/nemec_roca_ccs17_preprint.pdf][Source]]) -- The [[https://en.wikipedia.org/wiki/SigSpoof][SigSpoof Attack]] allows - an attacker to spoof digital signatures. - ([[https://arstechnica.%20com/information-technology/2018/06/decades-old-pgp-bug-allowed-hackers-to-spoof-just-about-anyones-signature/][Source]]) -- Libgcrypt 1.9.0 contains a severe flaw related to a heap buffer - overflow, fixed in Libgcrypt 1.9.1 - ([[https://web.archive.%20org/web/20210221012505/https://www.theregister.com/2021/01/29/severe_libgcrypt_bug/][Source]]) - -** Platforms -:PROPERTIES: -:CUSTOM_ID: platforms -:END: -Originally developed as a command-line program for *nix systems, GPG now -has a wealth of front-end applications and libraries available for +- GPG versions 1.0.2--1.2.3 contains a bug where "as soon as one + (GPG-generated) ElGamal signature of an arbitrary message is + released, one can recover the signer's private key in less than a + second on a PC." + ([Source](https://www.di.ens.fr/~pnguyen/pub_Ng04.htm)) +- GPG versions prior to 1.4.2.1 contain a false positive signature + verification bug. + ([Source](https://lists.gnupg.%20org/pipermail/gnupg-announce/2006q1/000211.html)) +- GPG versions prior to 1.4.2.2 cannot detect injection of unsigned + data. ( + [Source](https://lists.gnupg.org/pipermail/gnupg-announce/2006q1/000218.html)) +- Libgcrypt, a library used by GPG, contained a bug which enabled full + key recovery for RSA-1024 and some RSA-2048 keys. This was resolved + in a GPG update in 2017. + ([Source](https://lwn.net/Articles/727179/)) +- The [ROCA + Vulnerability](https://en.wikipedia.org/wiki/ROCA_vulnerability) + affects RSA keys generated by YubiKey 4 tokens. + ([Source](https://crocs.fi.%20muni.cz/_media/public/papers/nemec_roca_ccs17_preprint.pdf)) +- The [SigSpoof Attack](https://en.wikipedia.org/wiki/SigSpoof) allows + an attacker to spoof digital signatures. + ([Source](https://arstechnica.%20com/information-technology/2018/06/decades-old-pgp-bug-allowed-hackers-to-spoof-just-about-anyones-signature/)) +- Libgcrypt 1.9.0 contains a severe flaw related to a heap buffer + overflow, fixed in Libgcrypt 1.9.1 + ([Source](https://web.archive.%20org/web/20210221012505/https://www.theregister.com/2021/01/29/severe_libgcrypt_bug/)) + +## Platforms + +Originally developed as a command-line program for *nix systems, GPG +now has a wealth of front-end applications and libraries available for end-users. However, the most recommended programs remain the same: -- [[https://gnupg.org][GnuPG]] for Linux (depending on distro) -- [[https://gpg4win.org][Gpg4win]] for Windows -- [[https://gpgtools.org][GPGTools]] for macOS +- [GnuPG](https://gnupg.org) for Linux (depending on distro) +- [Gpg4win](https://gpg4win.org) for Windows +- [GPGTools](https://gpgtools.org) for macOS + +## Creating a Key Pair -** Creating a Key Pair -:PROPERTIES: -:CUSTOM_ID: creating-a-key-pair -:END: In order to create a GPG key pair, a user would first need to install -GPG on their system. If we're assuming that the user is on Fedora Linux, -they would execute the following: +GPG on their system. If we're assuming that the user is on Fedora +Linux, they would execute the following: -#+begin_src sh +```sh sudo dnf install gpg -#+end_src +``` Once installed, a user can create a new key pair with the following command(s): -#+begin_src sh +```sh gpg --full-generate-key -#+end_src +``` GPG will walk the user through an interactive setup that asks for an algorithm preference, expiration date, name, and email to associate with @@ -120,7 +116,7 @@ this key. See the following example key set-up for a default key generation using the GnuPG command-line interface: -#+begin_src sh +```sh gpg (GnuPG) 2.3.6; Copyright (C) 2021 Free Software Foundation, Inc. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. @@ -172,22 +168,20 @@ pub ed25519 2022-07-14 [SC] E955B7700FFC11EF51C2BA1FE096AACDD4C32E9C uid John Doe (test key) <johndoe@example.com> sub cv25519 2022-07-14 [E] -#+end_src +``` Please note that GUI apps may differ slightly from the GPG command-line interface. -** Common Usage -:PROPERTIES: -:CUSTOM_ID: common-usage -:END: +## Common Usage + As noted in RFC 4880, the general functions of OpenPGP are as follows: -- digital signatures -- encryption -- compression -- Radix-64 conversion -- key management and certificate services +- digital signatures +- encryption +- compression +- Radix-64 conversion +- key management and certificate services From this, you can probably gather that the main use of GPG is for encrypting data and/or signing the data with a key. The purpose of @@ -196,10 +190,8 @@ recipient(s) can access the data. Let's explore some specific GPG use-cases. -*** Email -:PROPERTIES: -:CUSTOM_ID: email -:END: +### Email + One of the more popular uses of GPG is to sign and/or encrypt emails. With the use of a GPG keypair, you can encrypt a message, its subject, and even the attachments within. @@ -214,8 +206,8 @@ The second process, regarding the actual encryption of the message and its contents, works by using a combination of the sender's keys and the recipient's keys. This process may vary slightly by implementation, but it most commonly uses asymmetric cryptography, also known as public-key -cryptography. In this version of encryption, the sender's private key to -sign the message and a combination of the sender's keys and the +cryptography. In this version of encryption, the sender's private key +to sign the message and a combination of the sender's keys and the recipient's public key to encrypt the message. If two people each have their own private keys and exchange their public @@ -227,66 +219,61 @@ Implementation of email encryption varies greatly between email clients, so you will need to reference your email client's documentation to ensure you are setting it up correctly for that specific client. -*** File Encryption -:PROPERTIES: -:CUSTOM_ID: file-encryption -:END: +### File Encryption + As noted in the section above regarding emails, GPG enables users to be able to send a message to each other if they are both set-up with GPG keys. In this example, I am going to show how a user could send a file -called =example_file.txt= to another user via the recipient's email. +called `example_file.txt` to another user via the +recipient's email. The sender would find the file they want to send and execute the following command: -#+begin_src sh +```sh gpg --encrypt --output example_file.txt.gpg --recipient \ recipient@example.com example_file.txt -#+end_src +``` Once received, the recipient can decrypt the file with the following command: -#+begin_src sh +```sh gpg --decrypt --output example_file.txt example_file.txt.gpg -#+end_src +``` + +### Ownership Signatures -*** Ownership Signatures -:PROPERTIES: -:CUSTOM_ID: ownership-signatures -:END: One important aspect of GPG, especially for developers, is the ability to sign data without encrypting it. For example, developers often sign code changes when they commit the changes back to a central repository, in order to display ownership of who made the changes. This allows other users to look at a code change and determine that the change was valid. -In order to do this using [[https://git-scm.com][Git]], the developer -simply needs to alter the =git commit= command to include the =-S= flag. -Here's an example: +In order to do this using [Git](https://git-scm.com), the developer +simply needs to alter the `git commit` command to include the +`-S` flag. Here's an example: -#+begin_src sh +```sh git commit -S -m "my commit message" -#+end_src +``` As an expansion of the example above, Git users can configure their environment with a default key to use by adding their GPG signature: -#+begin_src sh +```sh git config --global user.signingkey XXXXXXXXXXXXXXXX -#+end_src +``` -If you're not sure what your signature is, you can find it titled =sig= -in the output of this command: +If you're not sure what your signature is, you can find it titled +`sig` in the output of this command: -#+begin_src sh +```sh gpg --list-signatures -#+end_src +``` + +### File Integrity -*** File Integrity -:PROPERTIES: -:CUSTOM_ID: file-integrity -:END: When a person generates a signature for data, they are allowing users the ability to verify the signature on that data in the future to ensure the data has not been corrupted. This is most common with software @@ -296,26 +283,24 @@ replaced with dangerous software. In order to verify signed data, a user needs to have: -1. The signed data -2. A signature file -3. The public GPG key of the signer +1. The signed data +2. A signature file +3. The public GPG key of the signer -Once the signer's public key is imported on the user's system, and they -have the data and signature, they can verify the data with the following -commands: +Once the signer's public key is imported on the user's system, and +they have the data and signature, they can verify the data with the +following commands: -#+begin_src sh +```sh # If the signature is attached to the data gpg --verify [signature-file] # If the signature is detached as a separate file from the data gpg --verify [signature-file] [original-file] -#+end_src +``` + +## Finding Public Keys -** Finding Public Keys -:PROPERTIES: -:CUSTOM_ID: finding-public-keys -:END: In order to use GPG with others, a user needs to know the other user(s) keys. This is easy to do if the user knows the other user(s) in person, but may be hard if the relationship is strictly digital. Luckily, there @@ -324,5 +309,5 @@ social pages if they have them. Otherwise, the best option is to use a keyserver, such as: -- [[https://pgp.mit.edu][pgp.mit.edu]] -- [[https://keys.openpgp.org][keys.openpgp.org]] +- [pgp.mit.edu](https://pgp.mit.edu) +- [keys.openpgp.org](https://keys.openpgp.org) diff --git a/content/blog/2022-07-25-curseradio.md b/content/blog/2022-07-25-curseradio.md new file mode 100644 index 0000000..27b35d6 --- /dev/null +++ b/content/blog/2022-07-25-curseradio.md @@ -0,0 +1,106 @@ ++++ +date = 2022-07-25 +title = "CurseRadio: Listening to the Radio on the Comand Line" +description = "Use Curse Radio to listen to radio on the command-line." ++++ + +## Overview + +While exploring some interesting Linux applications, I stumbled across +[curseradio](https://github.com/chronitis/curseradio), a command-line +radio player based on Python. + +This application is fantastic and incredibly easy to install, so I +wanted to dedicate a post today to this app. Let's look at the features +within the app and then walk through the installation process I took to +get `curseradio` working. + +## Features + + + +The radio player itself is quite minimal. As you can see in the +screenshot above, it contains a simple plaintext list of all available +categories, which can be broken down further and further. In addition, +radio shows are available for listening, alongside regular radio +stations. + +For example, the `Sports` > `Pro Basketball` > +`Shows` category contains a number of specific shows related +to Professional Basketball. + +Aside from being able to play any of the listed stations/shows, you can +make a channel your favorite by pressing `f`. It will now +show up at the top of the radio player in the `Favourites` +category. + +### Commands/Shortcuts + + Key(s) Command + ------------ --------------------------------- + ↑, ↓ navigate + PgUp, PgDn navigate quickly + Home, End to top/bottom + Enter open/close folders, play stream + k stop playing stream + q quit + f toggle favourite + +## Installation + +### Dependencies + +Before installing `curseradio`, a handful of system and +Python packages are required. To get started, install +`python3`, `pip3`, and `mpv` on your +system. In this example, I'm using Fedora Linux, which uses the +`dnf` package manager. You may need to adjust this if you're +using a different system. + +```sh +sudo dnf install python3 pip3 mpv +``` + +Next, use `pip3` to install `requests`, +`xdg`, and `lxml`: + +```sh +pip3 install requests xdg lxml +``` + +### Repository Source Installation + +Once all the dependencies are installed, we can clone the source code +and enter that directory: + +```sh +git clone https://github.com/chronitis/curseradio && cd curseradio +``` + +Once you're within the `curseradio` directory, you can +install the application with the provided `setup.py` script. + +```sh +sudo python3 setup.py install +``` + +In my case, I ran into a few errors and needed to create the folders +that curseradio wanted to use for its installation. If you don't get +any errors, you can skip this and run the app. + +```sh +sudo mkdir /usr/local/lib/python3.10/ +sudo mkdir /usr/local/lib/python3.10/site-packages/ +``` + +```sh +sudo chown -R $USER:$USER /usr/local/lib/python3.10/ +``` + +## Run the Application + +Once fully installed without errors, you can run the application! + +```sh +python3 /usr/local/bin/curseradio +``` diff --git a/blog/2022-07-30-flac-to-opus.org b/content/blog/2022-07-30-flac-to-opus.md index 5d9d291..68ee04f 100644 --- a/blog/2022-07-30-flac-to-opus.org +++ b/content/blog/2022-07-30-flac-to-opus.md @@ -1,72 +1,70 @@ -#+title: Recursive Command-Line FLAC to Opus Conversion -#+date: 2022-07-30 ++++ +date = 2022-07-30 +title = "Recursive Command-Line FLAC to Opus Conversion" +description = "Learn how to convert all FLAC files to Opus, including recursive files in subdirectories." ++++ + +## Converting FLAC to OPUS -** Converting FLAC to OPUS -:PROPERTIES: -:CUSTOM_ID: converting-flac-to-opus -:END: I am currently rebuilding my music library from scratch so that I can -effectively archive all the music I own in the -[[https://en.wikipedia.org/wiki/FLAC][FLAC file format]], a lossless -audio codec. +effectively archive all the music I own in the [FLAC file +format](https://en.wikipedia.org/wiki/FLAC), a lossless audio codec. However, streaming FLAC files outside the home can be difficult due to the size of the files, especially if you're using a weak connection. So, in order to archive the music in a lossless format and still be able to stream it easily, I opted to create a copy of my FLAC files in the -[[https://en.wikipedia.org/wiki/Opus_(audio_format)][Opus audio codec]]. +[Opus audio codec](https://en.wikipedia.org/wiki/Opus_(audio_format)). This allows me to archive a quality, lossless version of the music and then point my streaming service to the smaller, stream-ready version. -*** Dependencies -:PROPERTIES: -:CUSTOM_ID: dependencies -:END: -The process I follow utilizes the =opus-tools= package in Ubuntu. Before -proceeding, install the package: +### Dependencies + +The process I follow utilizes the `opus-tools` package in +Ubuntu. Before proceeding, install the package: -#+begin_src sh +```sh sudo apt install opus-tools -#+end_src +``` -If you want to use a different conversion method, such as =ffmpeg= or -=avconv=, simply install that package instead. +If you want to use a different conversion method, such as +`ffmpeg` or `avconv`, simply install that package +instead. + +### Conversion Process -*** Conversion Process -:PROPERTIES: -:CUSTOM_ID: conversion-process -:END: The script I'm using is stored in my home directory, but feel free to create it wherever you want. It does not need to be in the same directory as your music files. -#+begin_src sh +```sh cd ~ && nano transform.sh -#+end_src +``` Once you have your new bash script opened in an editor, go ahead and paste the following logic into the script. -You *MUST* edit the following variables in order for it to work: +You **MUST** edit the following variables in order for it to work: -- =source=: The source directory where your FLAC files are stored. -- =dest=: The destination directory where you want the resulting Opus - files to be stored. +- `source`: The source directory where your FLAC files are + stored. +- `dest`: The destination directory where you want the + resulting Opus files to be stored. -You *MAY* want to edit the following variables to suit your needs: +You **MAY** want to edit the following variables to suit your needs: -- =filename=: If you are converting to a file format other than Opus, - you'll need to edit this so that your resulting files have the correct - filename extension. -- =reldir=: This variable can be edited to strip out more leading - directories in the file path. As you'll see later, I ignore this for - now and simply clean it up afterward. -- =opusenc=: This is the actual conversion process. You may want to edit - the bitrate to suit your needs. I set mine at 128 but some prefer 160 - or higher. +- `filename`: If you are converting to a file format other + than Opus, you'll need to edit this so that your resulting files + have the correct filename extension. +- `reldir`: This variable can be edited to strip out more + leading directories in the file path. As you'll see later, I ignore + this for now and simply clean it up afterward. +- `opusenc`: This is the actual conversion process. You may + want to edit the bitrate to suit your needs. I set mine at 128 but + some prefer 160 or higher. -#+begin_src sh +```sh #!/bin/bash ## - The IFS takes care of spaces in file and dirnames ## - your folders may vary @@ -128,55 +126,52 @@ opusenc --vbr --bitrate 128 --date "$DATE" \ ## just for testing # sleep 1 done -#+end_src +``` Once you're done, simply save the file and exit your editor. Don't forget to enable execution of the script: -#+begin_src sh +```sh chmod +x transform.sh -#+end_src +``` Finally, you may now run the script: -#+begin_src sh +```sh ./transform.sh -#+end_src - -If you used =opusenc=, you'll see the conversions happen within the -terminal as it progresses. You will also see variables printed if you -uncommented any of the bash script's comments. - -*** Cleanup -:PROPERTIES: -:CUSTOM_ID: cleanup -:END: -As I noted above, I didn't customize my =reldir= variable in the script, -which caused my output directory to be =/mnt/music/library/archives= -instead of =/mnt/music/library=. So, I moved the output up one level and +``` + +If you used `opusenc`, you'll see the conversions happen +within the terminal as it progresses. You will also see variables +printed if you uncommented any of the bash script's comments. + +### Cleanup + +As I noted above, I didn't customize my `reldir` variable in +the script, which caused my output directory to be +`/mnt/music/library/archives` instead of +`/mnt/music/library`. So, I moved the output up one level and deleted the accidental directory. -#+begin_src sh +```sh cd /mnt/music/library mv archives/* . rm -rf archives -#+end_src +``` + +### Check the Resulting Size -*** Check the Resulting Size -:PROPERTIES: -:CUSTOM_ID: check-the-resulting-size -:END: -If you want to see what kind of file size savings you've gained, you can -always use the =du= command to check: +If you want to see what kind of file size savings you've gained, you +can always use the `du` command to check: -#+begin_src sh +```sh cd /mnt/music du -h --max-depth=1 . -#+end_src +``` In my case, my small library went from 78GB to 6.3GB! -#+begin_src txt +```txt 78G ./archives 6.3G ./library -#+end_src +``` diff --git a/blog/2022-07-31-bash-it.org b/content/blog/2022-07-31-bash-it.md index 47e726b..18fceb8 100644 --- a/blog/2022-07-31-bash-it.org +++ b/content/blog/2022-07-31-bash-it.md @@ -1,126 +1,117 @@ -#+title: Upgrade Bash with Bash-It & Ble.sh -#+date: 2022-07-31 ++++ +date = 2022-07-31 +title = "Upgrade Bash with Bash-It & Ble.sh" +description = "Learn how to increase the power of bash with Bash-It and Ble.sh." ++++ + +## Bash -** Bash -:PROPERTIES: -:CUSTOM_ID: bash -:END: For those who are not familiar, -[[https://en.wikipedia.org/wiki/Bash_(Unix_shell)][Bash]] is a Unix -shell that is used as the default login shell for most Linux -distributions. This shell and command processor should be familiar if -you've used Linux (or older version of macOS) before. +[Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) is a Unix shell +that is used as the default login shell for most Linux distributions. +This shell and command processor should be familiar if you've used +Linux (or older version of macOS) before. However, bash is not the only option. There are numerous other shells that exist. Here are some popular examples: -- [[https://en.wikipedia.org/wiki/Z_shell][zsh]] -- [[https://en.wikipedia.org/wiki/Fish_(Unix_shell)][fish]] -- [[https://github.com/ibara/oksh][oksh]] -- [[https://wiki.gentoo.org/wiki/Mksh][mksh]] -- [[https://en.wikipedia.org/wiki/Debian_Almquist_shell][dash]] +- [zsh](https://en.wikipedia.org/wiki/Z_shell) +- [fish](https://en.wikipedia.org/wiki/Fish_(Unix_shell)) +- [oksh](https://github.com/ibara/oksh) +- [mksh](https://wiki.gentoo.org/wiki/Mksh) +- [dash](https://en.wikipedia.org/wiki/Debian_Almquist_shell) While each shell has its differences, bash is POSIX compliant and the default for many Linux users. Because of this, I am going to explore a -program called =bash-it= below that helps bash users increase the -utility of their shell without installing a completely new shell. +program called `bash-it` below that helps bash users increase +the utility of their shell without installing a completely new shell. + +### Installation -*** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: First, if bash is not already installed on your system, you can -[[https://www.gnu.org/software/bash/][download bash from GNU]] or use -your package manager to install it. +[download bash from GNU](https://www.gnu.org/software/bash/) or use your +package manager to install it. For example, this is how you can install bash on Fedora Linux: -#+begin_src sh +```sh sudo dnf install bash -#+end_src +``` -If you are not using bash as your default shell, use the =chsh= command -to change your shell: +If you are not using bash as your default shell, use the +`chsh` command to change your shell: -#+begin_src sh +```sh chsh -#+end_src +``` -You should see a prompt like the one below. If the brackets (=[]=) -contain =bash= already, you're done, and you can simply continue by -hitting the Enter key. +You should see a prompt like the one below. If the brackets +(`[]`) contain `bash` already, you're done, and +you can simply continue by hitting the Enter key. If the brackets contain another shell path (e.g. =/usr/bin/zsh=), enter -the path to the bash program on your system (it's most likely located at -=/usr/bin/bash=). +the path to the bash program on your system (it's most likely located +at `/usr/bin/bash`). -#+begin_src sh +```sh Changing shell for <user>. New shell [/usr/bin/bash]: -#+end_src +``` You must log out or restart the machine in order for the login shell to be refreshed. You can do it now or wait until you're finished customizing the shell. -#+begin_src sh +```sh sudo reboot now -#+end_src +``` -** Bash-it -:PROPERTIES: -:CUSTOM_ID: bash-it -:END: -As noted on the [[https://github.com/Bash-it/bash-it][Bash-it]] -repository: +## Bash-it -#+begin_quote -Bash-it is a collection of community Bash commands and scripts for Bash -3.2+. (And a shameless ripoff of oh-my-zsh 😃) +As noted on the [Bash-it](https://github.com/Bash-it/bash-it) +repository: -#+end_quote +> Bash-it is a collection of community Bash commands and scripts for +> Bash 3.2+. (And a shameless ripoff of oh-my-zsh 😃) Bash-it makes it easy to install plugins, set up aliases for common commands, and easily change the visual theme of your shell. -*** Installation -:PROPERTIES: -:CUSTOM_ID: installation-1 -:END: +### Installation + To install the framework, simply copy the repository files and use the -=install.sh= script provided. If you want, you can (and should!) inspect -the contents of the installation script before you run it. +`install.sh` script provided. If you want, you can (and +should!) inspect the contents of the installation script before you run +it. -#+begin_src sh +```sh git clone --depth=1 https://github.com/Bash-it/bash-it.git ~/.bash_it ~/.bash_it/install.sh -#+end_src +``` If you didn't restart your session after making bash the default, and are currently working within another shell, be sure to enter a bash -session before using =bash-it=: +session before using `bash-it`: -#+begin_src sh +```sh bash -#+end_src +``` + +### Aliases -*** Aliases -:PROPERTIES: -:CUSTOM_ID: aliases -:END: Bash-it contains a number of aliases for common commands to help improve efficiency in the terminal. To list all available options, use the following command: -#+begin_src sh +```sh bash-it show aliases -#+end_src +``` This will provide you a list that looks like the following text block. Within this screen, you will be able to see all available options and which ones are currently enabled. -#+begin_src txt +```txt Alias Enabled? Description ag [ ] the silver searcher (ag) aliases ansible [ ] ansible abbreviations @@ -133,35 +124,33 @@ clipboard [ ] xclip shortcuts composer [ ] common composer abbreviations curl [x] Curl aliases for convenience. ... -#+end_src +``` To enable an alias, do: -#+begin_src sh +```sh bash-it enable alias <alias name> [alias name]... -or- $ bash-it enable alias all -#+end_src +``` To disable an alias, do: -#+begin_src sh +```sh bash-it disable alias <alias name> [alias name]... -or- $ bash-it disable alias all -#+end_src +``` + +### Plugins -*** Plugins -:PROPERTIES: -:CUSTOM_ID: plugins -:END: Similar to aliases, plugins are available with bash-it. You can find a complete list of plugins in the same way as aliases. Simply execute the following: -#+begin_src sh +```sh bash-it show plugins -#+end_src +``` You will see the following output showing enabled and disabled plugins: -#+begin_src txt +```txt Plugin Enabled? Description alias-completion [ ] autojump [ ] Autojump configuration, see https://github.com/wting/autojump for more details @@ -172,87 +161,82 @@ battery [x] display info about your battery charge level blesh [ ] load ble.sh, the Bash line editor! boot2docker [ ] Helpers to get Docker setup correctly for boot2docker browser [ ] render commandline output in your browser -#+end_src +``` To enable a plugin, do: -#+begin_src sh +```sh bash-it enable plugin <plugin name> [plugin name]... -or- $ bash-it enable plugin all -#+end_src +``` To disable a plugin, do: -#+begin_src sh +```sh bash-it disable plugin <plugin name> [plugin name]... -or- $ bash-it disable plugin all -#+end_src +``` + +### Themes -*** Themes -:PROPERTIES: -:CUSTOM_ID: themes -:END: There are quite a few pre-defined -[[https://bash-it.readthedocs.io/en/latest/themes-list/#list-of-themes][themes]] +[themes](https://bash-it.readthedocs.io/en/latest/themes-list/#list-of-themes) available with bash-it. To list all themes: -#+begin_src sh +```sh ls ~/.bash_it/themes/ -#+end_src +``` -To use a new theme, you'll need to edit =.bashrc= and alter the -=BASH_IT_THEME= variable to your desired theme. For example, I am using -the =zork= theme. +To use a new theme, you'll need to edit `.bashrc` and alter +the `BASH_IT_THEME` variable to your desired theme. For +example, I am using the `zork` theme. -#+begin_src sh +```sh nano ~/.bashrc -#+end_src +``` -#+begin_src sh +```sh export BASH_IT_THEME='zork' -#+end_src +``` Once you save your changes, you just need to exit your terminal and -create a new one in order to see your changes to the =.bashrc= file. You -can also =source= the file to see changes, but I recommend starting a -completely new shell instead. - -** ble.sh -:PROPERTIES: -:CUSTOM_ID: ble.sh -:END: -One big feature I was missing in Bash that both =zsh= and =fish= have is -an autosuggestion feature. To explain: as you type, an autosuggestion -feature in the shell will offer suggestions in a lighter font color -beyond the characters already typed. Once you see the command you want, -you can click the right arrow and have the shell auto-complete that line -for you. - -Luckily, the [[https://github.com/akinomyoga/ble.sh][Bash Line Editor]] +create a new one in order to see your changes to the +`.bashrc` file. You can also `source` the file to +see changes, but I recommend starting a completely new shell instead. + +## ble.sh + +One big feature I was missing in Bash that both `zsh` and +`fish` have is an autosuggestion feature. To explain: as you +type, an autosuggestion feature in the shell will offer suggestions in a +lighter font color beyond the characters already typed. Once you see the +command you want, you can click the right arrow and have the shell +auto-complete that line for you. + +Luckily, the [Bash Line Editor](https://github.com/akinomyoga/ble.sh) (ble.sh) exists! This program provides a wonderful autosuggestions feature perfectly, among other features that I haven't tested yet. In order to install ble.sh, execute the following: -#+begin_src sh +```sh git clone --recursive https://github.com/akinomyoga/ble.sh.git make -C ble.sh install PREFIX=~/.local echo 'source ~/.local/share/blesh/ble.sh' >> ~/.bashrc -#+end_src +``` Again, exit the terminal and open a new one in order to see the newly-configured shell. -** Restart the Session -:PROPERTIES: -:CUSTOM_ID: restart-the-session -:END: +## Restart the Session + Finally, as mentioned above, you'll need to restart the session to ensure that your user is using bash by default. You will also need to exit and re-open a shell (e.g., terminal or -terminal tab) any time you make changes to the =.bashrc= file. +terminal tab) any time you make changes to the `.bashrc` +file. -#+begin_src sh +```sh sudo reboot now -#+end_src +``` diff --git a/blog/2022-08-31-privacy.com-changes.org b/content/blog/2022-08-31-privacy.com-changes.md index c734a5e..1287d2c 100644 --- a/blog/2022-08-31-privacy.com-changes.org +++ b/content/blog/2022-08-31-privacy.com-changes.md @@ -1,25 +1,24 @@ -#+title: Concerning Changes on Privacy.com -#+date: 2022-08-31 ++++ +date = 2022-08-31 +title = "Concering Changes on Privacy.com" +description = "My thoughts on Privacy.com changing from a prepaid model to a credit charge model." ++++ + +## Privacy.com Changes Their Terms -** Privacy.com Changes Their Terms -:PROPERTIES: -:CUSTOM_ID: privacy.com-changes-their-terms -:END: Recently, Privacy.com reached out to their customers regarding a change in their terms of use. Further, all customers are required to agree to the changes in order to continue using their accounts. -[[https://privacy.com/commercial-cardholder-agreement][You can view the -new cardholder agreement here]]. +[You can view the new cardholder agreement +here](https://privacy.com/commercial-cardholder-agreement). When you log in, you'll be greeted with a pop-up window asking you to review and agree to the new terms of use. You will also not be able to open any new cards until the terms are agreed to. -*** Changing from a "Prepaid Debit" Model to a "Charge Card" Model -:PROPERTIES: -:CUSTOM_ID: changing-from-a-prepaid-debit-model-to-a-charge-card-model -:END: +### Changing from a "Prepaid Debit" Model to a "Charge Card" Model + The actual content of the changes is interesting. While the historical model of using Privacy.com was akin to prepaid debit cards, the new model is very similar to a credit card (they use the term "charge @@ -38,17 +37,15 @@ charges through Privacy.com and set the merchant as one of their pre-set options, such as "Smiley's Corner Store" or "NSA Gift Shop." The new model still works with a bank account as a funding source, but -the model is changed so that you get a "line of credit" set according to -a 14-day billing cycle. It seems that Privacy.com will now allow charges -to be incurred without being immediately paid. - -*** Daily Payments and Available Credit -:PROPERTIES: -:CUSTOM_ID: daily-payments-and-available-credit -:END: +the model is changed so that you get a "line of credit" set according +to a 14-day billing cycle. It seems that Privacy.com will now allow +charges to be incurred without being immediately paid. + +### Daily Payments and Available Credit + Instead of paying as charges are incurred, you must make a "Daily -Payment" and your "Available Credit" will be locked until you make that -payment. There are also "End of Billing Cycle Payments" that are +Payment" and your "Available Credit" will be locked until you make +that payment. There are also "End of Billing Cycle Payments" that are assigned a due date. Further, Privacy.com will decline charges that would cause you to exceed @@ -56,23 +53,18 @@ your Available Credit or Credit Limit. One particular interesting section states the following: -#+begin_quote -YOUR OBLIGATION TO PAY US BACK FOR ALL CARD TRANSACTIONS AND OTHER -OBLIGATIONS YOU INCUR IS SECURED BY THE SECURED ACCOUNT. IF YOU DO NOT -PAY US BACK FOR ANY AMOUNT YOU OWE US WHEN YOUR PAYMENTS ARE DUE, WE -WILL EXERCISE OUR INTEREST AND DEBIT THE SECURED ACCOUNT, AND YOU WILL -LOSE THE MONEY IN THE SECURED ACCOUNT. SEE SECTION 8: SECURITY AGREEMENT -FOR MORE INFORMATION. +> YOUR OBLIGATION TO PAY US BACK FOR ALL CARD TRANSACTIONS AND OTHER +> OBLIGATIONS YOU INCUR IS SECURED BY THE SECURED ACCOUNT. IF YOU DO NOT +> PAY US BACK FOR ANY AMOUNT YOU OWE US WHEN YOUR PAYMENTS ARE DUE, WE +> WILL EXERCISE OUR INTEREST AND DEBIT THE SECURED ACCOUNT, AND YOU WILL +> LOSE THE MONEY IN THE SECURED ACCOUNT. SEE SECTION 8: SECURITY +> AGREEMENT FOR MORE INFORMATION. -#+end_quote +### Personal Information -*** Personal Information -:PROPERTIES: -:CUSTOM_ID: personal-information -:END: Now that Privacy.com is more of a financial institution, they are -obligated to comply with the -[[https://en.wikipedia.org/wiki/Know_your_customer][know your customer]] +obligated to comply with the [know your +customer](https://en.wikipedia.org/wiki/Know_your_customer) guidelines/laws. I did not proceed with the change to my Privacy.com account, but I have @@ -81,17 +73,13 @@ to be submitted, such as SSN. I am not aware of all new personal information required or if the funding source is now required to only be a bank account. -*** Fees -:PROPERTIES: -:CUSTOM_ID: fees -:END: +### Fees + Luckily, the fees section did not change much. The subscription fees for a premium account are still the only fees. -** My Thoughts -:PROPERTIES: -:CUSTOM_ID: my-thoughts -:END: +## My Thoughts + Personally, I wiped my personal information from my account and then permanently deleted it when I heard about these changes. I have no interest in yet another method of credit lending offered by private @@ -105,6 +93,6 @@ This type of change toward a "buy it now, pay us later" model is concerning, and I will be watching Privacy.com to see if they further their interests in the credit model as time goes on. -Could we see them start charging interest, fees, etc.? I'm not sure, but -this change does not inspire confidence in their mission as a +Could we see them start charging interest, fees, etc.? I'm not sure, +but this change does not inspire confidence in their mission as a privacy-focused company. diff --git a/blog/2022-09-17-serenity-os.org b/content/blog/2022-09-17-serenity-os.md index d3da4b1..d58805c 100644 --- a/blog/2022-09-17-serenity-os.org +++ b/content/blog/2022-09-17-serenity-os.md @@ -1,11 +1,12 @@ -#+title: Serenity OS: Testing Out a Unique System -#+date: 2022-09-17 - -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: -[[https://serenityos.org][SerenityOS]] is a unique operating system (OS) ++++ +date = 2022-09-17 +title = "Serenity OS: Testing Out a Unique System" +description = "A quick look at the Serenity operating system." ++++ + +## Overview + +[SerenityOS](https://serenityos.org) is a unique operating system (OS) that I have seen pop up in my news feed a few times over the last few years, but I have never had time to test it out until now. @@ -15,51 +16,42 @@ to my youth. Per their website: -#+begin_quote -A graphical Unix-like operating system for desktop computers! - -SerenityOS is a love letter to '90s user interfaces with a custom -Unix-like core. It flatters with sincerity by stealing beautiful ideas -from various other systems. - -Roughly speaking, the goal is a marriage between the aesthetic of -late-1990s productivity software and the power-user accessibility of -late-2000s *nix. +> A graphical Unix-like operating system for desktop computers! +> +> SerenityOS is a love letter to '90s user interfaces with a custom +> Unix-like core. It flatters with sincerity by stealing beautiful ideas +> from various other systems. +> +> Roughly speaking, the goal is a marriage between the aesthetic of +> late-1990s productivity software and the power-user accessibility of +> late-2000s *nix. +> +> This is a system by us, for us, based on the things we like. -This is a system by us, for us, based on the things we like. +## Building -#+end_quote +Your first question may be "Where's the iso?" and the answer is... +there are none. SerenityOS does not provide pre-built images for +testing. You must build the images yourself. This seems intentionally to +limit participation to only those who are truly interested enough to +learn how to build the OS. -** Building -:PROPERTIES: -:CUSTOM_ID: building -:END: -Your first question may be "Where's the iso?" and the answer is... there -are none. SerenityOS does not provide pre-built images for testing. You -must build the images yourself. This seems intentionally to limit -participation to only those who are truly interested enough to learn how -to build the OS. +### Clone -*** Clone -:PROPERTIES: -:CUSTOM_ID: clone -:END: In order to get started, you'll need to clone the source repository: -#+begin_src sh +```sh git clone https://github.com/SerenityOS/serenity && cd serenity -#+end_src - -*** Build -:PROPERTIES: -:CUSTOM_ID: build -:END: -Note that I followed the -[[https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md][Build -Instructions]] in the SerenityOS repository as of commit -=660d2b53b1206e868d5470eee80b5e62d7e30da7=. Things may have changed -since my installation, and you should double-check the instructions -first. +``` + +### Build + +Note that I followed the [Build +Instructions](https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md) +in the SerenityOS repository as of commit +`660d2b53b1206e868d5470eee80b5e62d7e30da7`. Things may have +changed since my installation, and you should double-check the +instructions first. Regardless, I want to repeat my steps here to illustrate any errors or differing commands I needed to run in order to build and run SerenityOS. @@ -67,61 +59,58 @@ differing commands I needed to run in order to build and run SerenityOS. Since I am running Fedora, I needed to install these packages in order to build the OS images: -#+begin_src sh +```sh sudo dnf install texinfo binutils-devel curl cmake mpfr-devel libmpc-devel gmp-devel e2fsprogs ninja-build patch ccache rsync @"C Development Tools and Libraries" @Virtualization -#+end_src +``` -Next, make sure you're inside the =serenity= directory created earlier -during the git cloning process and process to build the toolchain: +Next, make sure you're inside the `serenity` directory +created earlier during the git cloning process and process to build the +toolchain: -#+begin_src sh +```sh Meta/serenity.sh rebuild-toolchain -#+end_src +``` Once the toolchain is built, you can Build and run the OS! -#+begin_src sh +```sh Meta/serenity.sh run -#+end_src +``` After this process is completed, the image should run automatically and launch. -** Issues -:PROPERTIES: -:CUSTOM_ID: issues -:END: +## Issues + I played around in SerenityOS for an hour or two in order to see what I could do and had a lot of fun with it. The only issue I ran into was a lack of working internet. I didn't try very hard, but I could tell that the main network link wasn't connecting to my Fedora host properly. -** Screenshots -:PROPERTIES: -:CUSTOM_ID: screenshots -:END: +## Screenshots + The initial launch of the image displays the SerenityOS desktop, with a simple terminal already launched: -[[https://img.cleberg.net/blog/20220917-serenityos/initial_launch.png]] + Here you can see the Fire application (literally just shows fire burning), a browser with the local Serenity Browser page loaded, and a text editor. -[[https://img.cleberg.net/blog/20220917-serenityos/basic_apps.png]] + I also poked around the system utilities and found most tools you'd expect to find within a standard desktop. -[[https://img.cleberg.net/blog/20220917-serenityos/system_monitor.png]] + Lastly, I noted that the default desktop contains numerous pre-defined themes to choose from. This is a small piece, but it's actually wonderful to see desktop developers consider theming directly out of the box rather than using an addon-based mentality. -[[https://img.cleberg.net/blog/20220917-serenityos/themes.png]] + I didn't take a screenshot of the other pre-installed games, but I did spend nearly 30 minutes playing Solitaire before remembering that I was diff --git a/content/blog/2022-09-21-graphene-os.md b/content/blog/2022-09-21-graphene-os.md new file mode 100644 index 0000000..38dba12 --- /dev/null +++ b/content/blog/2022-09-21-graphene-os.md @@ -0,0 +1,167 @@ ++++ +date = 2022-09-21 +title = "Installing Graphene OS on the Pixel 6 Pro" +description = "A retrospective on the successful command-line installation of Graphene OS on a Pixel 6 Pro." ++++ + +## Introduction + +After using iOS for a couple of years, I finally took the plunge and +purchased a Pixel 6 Pro in order to test and use [GrapheneOS] +(<https://grapheneos.org>). + +The installation process was rather quick once you have the tools and +files you need. Overall, it can be done in just a few minutes. + +## Gathering Tools & Files + +### Android Tools + +First, in order to interact with the device, we will need the [Android +platform +tools](https://developer.android.com/studio/releases/platform-tools.html). +Find the Linux download and save the ZIP folder to your preferred +location. + +Once we've downloaded the files, we will need to unzip them, enter the +directory, and move the necessary executables to a central location, +such as `/usr/bin/`. For this installation, we only need the +`fastboot` and `adb` executables. + +```sh +cd ~/Downloads +``` + +```sh +unzip platform-tools_r33.0.3-linux.zip +cd platform-tools +sudo mv fastboot /usr/bin/ +sudo mv adb /usr/bin +``` + +### GrapheneOS Files + +Next, we need the [GrapheneOS files](https://grapheneos.org/releases) +for our device and model. For example, the Pixel 6 Pro is codenamed +`raven` on the release page. + +Once we have the links, let's download them to our working directory: + +```sh +curl -O https://releases.grapheneos.org/factory.pub +curl -0 https://releases.grapheneos.org/raven-factory-2022091400.zip +curl -0 https://releases.grapheneos.org/raven-factory-2022091400.zip.sig +``` + +1. Validate Integrity + + In order to validate the integrity of the downloaded files, we will + need the `signify` package and Graphene's + `factory.pub` file. + + ```sh + sudo dnf install signify + ``` + + ```sh + curl -O https://releases.grapheneos.org/factory.pub + ``` + + Then we can validate the files and ensure that no data was corrupted + or modified before it was saved to our device. + + ```sh + signify -Cqp factory.pub -x raven-factory-2022091400.zip.sig && echo verified + ``` + +2. Unzip Files + + Once the files are verified, we can unzip the Graphene image and + enter the directory: + + ```sh + unzip raven-factory-2022091400.zip && cd raven-factory-2022091400 + ``` + +## Installation Process + +### Enable Developer Debugging & OEM Unlock + +Before we can actually flash anything to the phone, we will need to +enable OEM Unlocking, as well as either USB Debugging or Wireless +Debugging, depending on which method we will be using. + +To start, enable developer mode by going to `Settings` > +`About` and tapping `Build Number` seven (7) +times. You may need to enter your PIN to enable this mode. + +Once developer mode is enabled, go to `Settings` > +`System` > `Devloper Options` and enable OEM +Unlocking, as well as USB or Wireless Debugging. In my case, I chose USB +Debugging and performed all actions via USB cable. + +Once these options are enabled, plug the phone into the computer and +execute the following command: + +```sh +adb devices +``` + +If an unauthorized error occurs, make sure the USB mode on the phone is +changed from charging to something like "File Transfer" or "PTP." +You can find the USB mode in the notification tray. + +### Reboot Device + +Once we have found the device via `adb`, we can either boot +into the bootloader interface by holding the volume down button while +the phone reboots or by executing the following command: + +```sh +adb reboot bootloader +``` + +### Unlock the Bootloader + +The phone will reboot and load the bootloader screen upon startup. At +this point, we are ready to start the actual flashing of GrapheneOS onto +the device. + +**NOTE**: In my situation, I needed to use `sudo` with every +`fastboot` command, but not with `adb` commands. I +am not sure if this is standard or a Fedora quirk, but I'm documenting +my commands verbatim in this post. + +First, we start by unlocking the bootloader so that we can load other +ROMs: + +```sh +sudo fastboot flashing unlock +``` + +### Flashing Factory Images + +Once the phone is unlocked, we can flash it with the +`flash-all.sh` script found inside the +`raven-factory-2022091400` folder we entered earlier: + +```sh +sudo ./flash-all.sh +``` + +This process should take a few minutes and will print informational +messages as things progress. Avoid doing anything on the phone while +this process is operating. + +### Lock the Bootloader + +If everything was successful, the phone should reboot a few times and +finally land back on the bootloader screen. At this point, we can +re-lock the bootloader to enable full verified boot and protect the +device from unwanted flashing or erasure of data. + +```sh +sudo fastboot flashing lock +``` + +Once done, the device will be wiped and ready for a fresh set-up! diff --git a/blog/2022-10-04-mtp-linux.org b/content/blog/2022-10-04-mtp-linux.md index 0117fbd..662704a 100644 --- a/blog/2022-10-04-mtp-linux.org +++ b/content/blog/2022-10-04-mtp-linux.md @@ -1,14 +1,16 @@ -#+title: How to Mount an MTP Mobile Device on Linux -#+date: 2022-10-04 ++++ +date = 2022-10-04 +title = "How to Mount an MTP Mobile Device on Fedora Linux" +description = "Learn how to mount an MTP mobile device on Fedora Linux." ++++ -I recently ran into trouble attempting to mount my GrapheneOS phone to my laptop -running Fedora Linux via the [[https://en.wikipedia.org/wiki/Media_transfer_protocol][Media Transfer Protocol]] (MTP) and discovered a -simple and effective solution. +I recently ran into trouble attempting to mount my GrapheneOS phone to +my laptop running Fedora Linux via the [Media Transfer +Protocol](https://en.wikipedia.org/wiki/Media_transfer_protocol) (MTP) +and discovered a simple and effective solution. + +## Use a USB 3.0 Port -** Use a USB 3.0 Port -:PROPERTIES: -:CUSTOM_ID: use-a-usb-3.0-port -:END: First, ensure that the device was plugged in to the laptop through a USB 3.0 port, if possible. From a brief glance online, it seems that USB 2.0 ports may cause issues with dropped connections over MTP. This is purely @@ -16,70 +18,63 @@ anecdotal since I don't have any evidence to link showing that USB 2.0 causes issues, but I can confirm that switching to a USB 3.0 port seemed to cut out most of my issues. -** Switch USB Preferences to MTP -:PROPERTIES: -:CUSTOM_ID: switch-usb-preferences-to-mtp -:END: +## Switch USB Preferences to MTP + Secondly, you need to ensure that the phone's USB preferences/mode is changed to MTP or File Transfer once the phone is plugged in. Other modes will not allow you to access the phone's file system. -** Install =jmtpfs= -:PROPERTIES: -:CUSTOM_ID: install-jmtpfs -:END: -Next, I used the =jmtpfs= package to mount my phone to my laptop. There -are other packages that exist, but this one worked perfectly for me. On -Fedora Linux, you can install it like this: +## Install `jmtpfs` + +Next, I used the `jmtpfs` package to mount my phone to my +laptop. There are other packages that exist, but this one worked +perfectly for me. On Fedora Linux, you can install it like this: -#+begin_src sh +```sh sudo dnf install jmtpfs -y -#+end_src +``` + +## Create a Mount Point -** Create a Mount Point -:PROPERTIES: -:CUSTOM_ID: create-a-mount-point -:END: Once you have the package installed, you just need to create a folder -for the device to use as a mount point. In my case, I used =/mnt/pixel=: +for the device to use as a mount point. In my case, I used +`/mnt/pixel`: -#+begin_src sh +```sh sudo mkdir /mnt/pixel sudo chown -R $USER:$USER /mnt/pixel -#+end_src +``` + +## Mount & Access the Phone's File System -** Mount & Access the Phone's File System -:PROPERTIES: -:CUSTOM_ID: mount-access-the-phones-file-system -:END: Finally, plug-in and mount the device, and you should be able to see all storage (internal and external) inside your new folder! -#+begin_src sh +```sh jmtpfs /mnt/pixel -#+end_src +``` The output should look something like this: -#+begin_src sh +```sh Device 0 (VID=18d1 and PID=4ee1) is a Google Inc Nexus/Pixel (MTP). Android device detected, assigning default bug flags -#+end_src +``` Now you are mounted and can do anything you'd like with the device's files: -#+begin_src sh +```sh cd /mnt/pixel ls -lha -#+end_src +``` From here, you will be able to see any internal or external storage available on the device: -#+begin_src sh +```sh total 0 drwxr-xr-x. 3 user user 0 Jan 1 1970 . drwxr-xr-x. 1 root root 10 Oct 4 13:29 .. drwxr-xr-x. 16 user user 0 Apr 21 4426383 'Internal shared storage' -#+end_src +``` diff --git a/blog/2022-10-20-syncthing.org b/content/blog/2022-10-20-syncthing.md index 1892d48..94816e3 100644 --- a/blog/2022-10-20-syncthing.org +++ b/content/blog/2022-10-20-syncthing.md @@ -1,83 +1,70 @@ -#+title: Syncthing: A Minimal Self-Hosted Cloud Storage Solution -#+date: 2022-10-20 ++++ +date = 2022-10-04 +title = "Syncthing: A Minimal Self-Hosted Cloud Storage Solution" +description = "" ++++ + +## An Overview of Syncthing -** An Overview of Syncthing -:PROPERTIES: -:CUSTOM_ID: an-overview-of-syncthing -:END: If you've been looking around the self-hosted cloud storage space for a while, you've undoubtedly run into someone suggesting -[[https://syncthing.net][Syncthing]] as an option. However, it is an +[Syncthing](https://syncthing.net) as an option. However, it is an unusual alternative for those users out there who are used to having a -centralized cloud server that serves as the "controller" of the data and -interacts with clients on devices to fetch files. +centralized cloud server that serves as the "controller" of the data +and interacts with clients on devices to fetch files. This post is a walkthrough of the Syncthing software, how I set up my personal storage, and some pros and cons of using the software. -** Installing Syncthing -:PROPERTIES: -:CUSTOM_ID: installing-syncthing -:END: +## Installing Syncthing + To install Syncthing, visit the -[[https://syncthing.net/downloads/][Downloads]] page or install via your +[Downloads](https://syncthing.net/downloads/) page or install via your device's package manager. -*** Server & Desktop -:PROPERTIES: -:CUSTOM_ID: server-desktop -:END: +### Server & Desktop + You can install Syncthing on servers and desktops via the Downloads page linked above or via the command-line. For Debian-based distros: -#+begin_src sh +```sh sudo apt install syncthing -#+end_src +``` For Fedora-based distros: -#+begin_src sh +```sh sudo dnf install syncthing -#+end_src +``` + +### Mobile -*** Mobile -:PROPERTIES: -:CUSTOM_ID: mobile -:END: Syncthing for Android is available on -[[https://f-droid.org/packages/com.nutomic.syncthingandroid/][F-Droid]] -and -[[https://play.google.com/store/apps/details?id=com.nutomic.syncthingandroid][Google -Play]]. Syncthing does not have an official iOS client, but there is a -third-party client called -[[https://apps.apple.com/us/app/m%C3%B6bius-sync/id1539203216][Möbius -Sync]]. - -** How Does Syncthing Work? -:PROPERTIES: -:CUSTOM_ID: how-does-syncthing-work -:END: +[F-Droid](https://f-droid.org/packages/com.nutomic.syncthingandroid/) +and [Google +Play](https://play.google.com/store/apps/details?id=com.nutomic.syncthingandroid). +Syncthing does not have an official iOS client, but there is a +third-party client called [Möbius +Sync](https://apps.apple.com/us/app/m%C3%B6bius-sync/id1539203216). + +## How Does Syncthing Work? + To start, I wanted to include the main marketing blurb from their website: -#+begin_quote -Syncthing is a continuous file synchronization program. It synchronizes -files between two or more computers in real time, safely protected from -prying eyes. Your data is your data alone, and you deserve to choose -where it is stored, whether it is shared with some third party, and how -it's transmitted over the internet. - -#+end_quote +> Syncthing is a continuous file synchronization program. It +> synchronizes files between two or more computers in real time, safely +> protected from prying eyes. Your data is your data alone, and you +> deserve to choose where it is stored, whether it is shared with some +> third party, and how it's transmitted over the internet. Let's break this apart and add in some other details to help explain what exactly Syncthing does in order to sync files between devices. -*** Local Syncthing Server(s) -:PROPERTIES: -:CUSTOM_ID: local-syncthing-servers -:END: +### Local Syncthing Server(s) + Syncthing syncs files between multiple devices by creating a local server on each device. These local servers handle a few different things, such as watching files and directories for changes, hosting an @@ -85,43 +72,40 @@ administrative GUI website, and authenticating with connected devices. You can also start, stop, and restart the Syncthing server via the command-line or web dashboard. If you're running Syncthing on a device -with =systemd=, you can use the following commands: +with `systemd`, you can use the following commands: -#+begin_src sh +```sh sudo systemctl start syncthing@username.service sudo systemctl restart syncthing@username.service sudo systemctl stop syncthing@username.service -#+end_src +``` + +### Syncthing Dashboard -*** Syncthing Dashboard -:PROPERTIES: -:CUSTOM_ID: syncthing-dashboard -:END: This biggest part of Syncthing is the admin GUI website that runs on each device (note that mobile devices will use the Syncthing app rather than the web GUI). The admin GUI is available through the web browser on the local device that is running Syncthing - simply go to -=http://localhost:8384= or =http://127.0.0.1:8384=. This web page is the -place where you will change settings, add/modify synced files, and -add/modify connected devices. +`http://localhost:8384` or +`http://127.0.0.1:8384`. This web page is the place where you +will change settings, add/modify synced files, and add/modify connected +devices. Here's an example web GUI dashboard: -#+caption: Syncthing Dashboard -[[https://img.cleberg.net/blog/20221020-syncthing/syncthing_gui.png]] + + +### Remote Devices -*** Remote Devices -:PROPERTIES: -:CUSTOM_ID: remote-devices -:END: A cloud storage solution wouldn't be very useful if you aren't able to share data among various devices. Syncthing does this by sharing Device IDs to connect servers, and then by manually sharing Folders with devices that have been connected. For instance, if you have a laptop running Syncthing and then install -the Syncthing mobile app on a phone, you could scan the laptop's QR code -for Device ID and then accept the authentication on the laptop's +the Syncthing mobile app on a phone, you could scan the laptop's QR +code for Device ID and then accept the authentication on the laptop's dashboard. Next, you can use either device to select a folder for sharing and dictating which device should send, receive, or both. @@ -130,10 +114,8 @@ which can add devices from the introducer to the device list, for mutually shared folders. You can also configure Auto Accept, compression, rate limits, and more settings per device. -** My Personal Cloud Storage Set-up -:PROPERTIES: -:CUSTOM_ID: my-personal-cloud-storage-set-up -:END: +## My Personal Cloud Storage Set-up + Personally, I use a model similar to a traditional cloud storage service. I have a "centralized" server running 24/7 that acts as an Introducer for my Syncthing network. I think of this as my main storage @@ -147,52 +129,50 @@ network, both running intermittently as they are not powered-on 24/7. The initial set-up of the software was easy enough, but data transfer rates were incredibly slow for me due to the Wi-Fi. Instead, I plugged my laptop into the ethernet network that my server is on and manually -copied my folders over to the server with =scp=. Once complete, -Syncthing validated that all files were there and not missing, and it -did not need to transfer any data through the WAN. +copied my folders over to the server with `scp`. Once +complete, Syncthing validated that all files were there and not missing, +and it did not need to transfer any data through the WAN. As slow as the transfer was going, this probably saved me a few days of waiting for my ~100GB sync. -** Pros & Cons -:PROPERTIES: -:CUSTOM_ID: pros-cons -:END: -I've put together a short list of pros and cons for Syncthing. I thought -about my experiences with Nextcloud, WebDAV, proprietary services -(Google Drive, iCloud, etc.), and privacy-focused cloud solutions -(pCloud, Tresorit, etc.). - -*Pros:* - -- I've faced no data loss at all through my two-month trial run. -- No third-parties store your data on their servers. -- You have full control over your data and can take your data and leave - at any time. -- It's possible to encrypt client-side easily with software like - Cryptomator. -- No proprietary clients or mounted volumes, just plain files and - folders. - -*Cons:* - -- The learning curve is steeper than traditional cloud services and is - focused on a technical audience. -- If a device needs to modify files in a Folder, the devices will need - to sync ALL files from the folder, which may be large. To avoid size - restraints, split large folders into smaller folders for syncing. -- Syncing can be slow due to the clients/servers initially connecting or - re-connecting after sleeping. -- Multiple personal devices are required and require the user to own or - rent them as no third-party servers are involved in the storage of - data. - -Overall, I've had a great experience with Syncthing so far. I've had no -data loss, syncing has been quick and easy when changes are made to +## Pros & Cons + +I've put together a short list of pros and cons for Syncthing. I +thought about my experiences with Nextcloud, WebDAV, proprietary +services (Google Drive, iCloud, etc.), and privacy-focused cloud +solutions (pCloud, Tresorit, etc.). + +**Pros:** + +- I've faced no data loss at all through my two-month trial run. +- No third-parties store your data on their servers. +- You have full control over your data and can take your data and + leave at any time. +- It's possible to encrypt client-side easily with software like + Cryptomator. +- No proprietary clients or mounted volumes, just plain files and + folders. + +**Cons:** + +- The learning curve is steeper than traditional cloud services and is + focused on a technical audience. +- If a device needs to modify files in a Folder, the devices will need + to sync ALL files from the folder, which may be large. To avoid size + restraints, split large folders into smaller folders for syncing. +- Syncing can be slow due to the clients/servers initially connecting + or re-connecting after sleeping. +- Multiple personal devices are required and require the user to own + or rent them as no third-party servers are involved in the storage + of data. + +Overall, I've had a great experience with Syncthing so far. I've had +no data loss, syncing has been quick and easy when changes are made to files, device connections are reliable, and I love the freedom of controlling the clients and servers as I choose. Not to mention that I appreciate that I - or someone else - could pull -the Syncthing [[https://github.com/syncthing][source code]] and continue +the Syncthing [source code](https://github.com/syncthing) and continue development/support if the Syncthing Foundation decides to stop developing the software or sells the business. diff --git a/content/blog/2022-10-22-alpine-linux.md b/content/blog/2022-10-22-alpine-linux.md new file mode 100644 index 0000000..69b6a8b --- /dev/null +++ b/content/blog/2022-10-22-alpine-linux.md @@ -0,0 +1,280 @@ ++++ +date = 2022-10-22 +title = "Alpine Linux: My New Server OS" +description = "A retrospective on installing and configuring Alpine Linux as my new server operating system." ++++ + +## Alpine Linux + +[Alpine Linux](https://alpinelinux.org) is a very small distro, built on +musl libc and busybox. It uses ash as the default shell, OpenRC as the +init system, and apk as the package manager. According to their website, +an Alpine container "requires no more than 8 MB and a minimal +installation to disk requires around 130 MB of storage." An actual bare +metal machine is recommended to have 100 MB of RAM and 0-700 MB of +storage space. + +Historically, I've used Ubuntu's minimal installation image as my +server OS for the last five years. Ubuntu worked well and helped as my +original server contained an nVidia GPU and no onboard graphics, so +quite a few distros won't boot or install without a lot of tinkering. + +Alpine has given me a huge increase in performance across my Docker apps +and Nginx websites. CPU load for the new server I'm using to test +Alpine hovers around 0-5% on average with an Intel(R) Core(TM) i3-6100 +CPU @ 3.70GHz. + +The only services I haven't moved over to Alpine are Plex Media Server +and Syncthing, which may increase CPU load quite a bit depending on how +many streams are running. + +### Installation + +In terms of installation, Alpine has an incredibly useful +[wiki](https://wiki.alpinelinux.org/wiki/Installation) that will guide a +user throughout the installation and post-installation processes, as +well as various other articles and guides. + +To install Alpine, find an appropriate [image to +download](https://alpinelinux.org/downloads/) and flash it to a USB +using software such as Rufus or Etcher. I opted to use the Standard +image for my x86~64~ architecture. + +Once the USB is ready, plug it into the machine and reboot. Note that +you may have to use a key such as `Esc` or `F1-12` +to access the boot menu. The Alpine Linux terminal will load quickly and +for a login. + +To log in to the installation image, use the `root` account; +there is no password. Once logged-in, execute the setup command: + +```sh +setup-alpine +``` + +The setup script will ask a series of questions to configure the system. +Be sure to answer carefully or else you may have to re-configure the +system after boot. + +- Keyboard Layout (Local keyboard language and usage mode, e.g., us + and variant of us-nodeadkeys.) +- Hostname (The name for the computer.) +- Network (For example, automatic IP address discovery with the + "DHCP" protocol.) +- DNS Servers (Domain Name Servers to query. For privacy reasons, it + is NOT recommended to route every local request to servers like + Google's 8.8.8.8 .) +- Timezone +- Proxy (Proxy server to use for accessing the web. Use "none" for + direct connections to the internet.) +- Mirror (From where to download packages. Choose the organization you + trust giving your usage patterns to.) +- SSH (Secure SHell remote access server. "Openssh" is part of the + default install image. Use "none" to disable remote login, e.g. on + laptops.) +- NTP (Network Time Protocol client used for keeping the system clock + in sync with a time-server. Package "chrony" is part of the + default install image.) +- Disk Mode (Select between diskless (disk="none"), "data" or + "sys", as described above.) + +Once the setup script is finished, be sure to reboot the machine and +remove the USB device. + +```sh +reboot +``` + +### Post-Installation + +There are many things you can do once your Alpine Linux system is up and +running, and it largely depends on what you'll use the machine for. +I'm going to walk through my personal post-installation setup for my +web server. + +1. Upgrade the System + + First, login as `root` in order to update and upgrade the + system: + + ```sh + apk -U upgrade + ``` + +2. Adding a User + + I needed to add a user so that I don't need to log in as root. Note + that if you're used to using the `sudo` command, you + will now need to use the `doas` command on Alpine Linux. + + ```sh + apk add doas + adduser <username> + adduser <username> wheel + ``` + + You can now log out and log back in using the newly-created user: + + ```sh + exit + ``` + +3. Enable Community Packages + + In order to install more common packages that aren't found in the + `main` repository, you will need to enable the + `community` repository: + + ```sh + doas nano /etc/apk/repositories + ``` + + Uncomment the community line for whichever version of Alpine you're + running: + + ```sh + /media/usb/apks + http://dl-cdn.alpinelinux.org/alpine/v3.16/main + http://dl-cdn.alpinelinux.org/alpine/v3.16/community + #http://dl-cdn.alpinelinux.org/alpine/edge/main + #http://dl-cdn.alpinelinux.org/alpine/edge/community + #http://dl-cdn.alpinelinux.org/alpine/edge/testing + ``` + +4. Install Required Packages + + Now that the community packages are available, you can install any + packages you need. In my case, I installed the web server packages I + need for my services: + + ```sh + doas apk add nano nginx docker docker-compose ufw + ``` + +5. SSH + + If you didn't install OpenSSH as part of the installation, you can + do so now: + + ```sh + doas apk add openssh + ``` + + Next, either create a new key or copy your SSH key to the server + from your current machines: + + ```sh + # Create a new key + ssh-keygen + ``` + + If you need to copy an existing SSH key from a current machine: + + ```sh + # Copy key from existing machines + ssh-copy-id <username>@<ip_address> + ``` + +6. Firewall + + Lastly, I installed `ufw` above as my firewall. To set + up, default to deny incoming and allow outgoing connections. Then + selectively allow other ports or apps as needed. + + ```sh + doas ufw default deny incoming + doas ufw default allow outgoing + doas ufw allow SSH + doas ufw allow "WWW Full" + doas ufw allow 9418 # Git server port + ``` + +7. Change Hostname + + If you don't like the hostname set during installation, you just + need to edit two files. First, edit the simple hostname file: + + ```sh + doas nano /etc/hostname + ``` + + ```sh + <hostname> + ``` + + Next, edit the `hosts` file: + + ```sh + doas nano /etc/hosts + ``` + + ```sh + 127.0.0.1 <hostname>.local <hostname> localhost.local localhost + ::1 <hostname> <hostname>.local + ``` + +## Nginx Web Server + +To set up my web server, I simply created the `www` user and +created the necessary files. + +```sh +doas adduser -D -g 'www' www +mkdir /www +doas mkdir /www +doas chown -R www:www /var/lib/nginx/ +doas chown -R www:www /www +``` + +If you're running a simple webroot, you can alter the main +`nginx.conf` file. Otherwise, you can drop configuration +files in the following directory. You don't need to enable or symlink +the configuration file like you do in other systems. + +```sh +doas nano /etc/nginx/http.d/example_website.conf +``` + +Once the configuration is set and pointed at the `/www` +directory to serve files, enable the Nginx service: + +```sh +# Note that 'default' must be included or Nginx will not start on boot +doas rc-update add nginx default +``` + +## Docker Containers + +Docker works exactly the same as other systems. Either execute a +`docker run` command or create a +`docker-compose.yml` file and do +`docker-compose up -d`. + +## Git Server + +I went in-depth on how to self-host a git server in another post: +[Self-Hosting a Personal Git Server](/blog/git-server/). + +However, there are a few differences with Alpine. First note that in +order to change the `git` user's shell, you must do a few +things a little different: + +```sh +doas apk add libuser +doas touch /etc/login.defs +doas mkdir /etc/default +doas touch /etc/default/useradd +doas lchsh git +``` + +## Thoughts on Alpine + +So far, I love Alpine Linux. I have no complaints about anything at this +point, but I'm not completely finished with the migration yet. Once +I'm able to upgrade my hardware to a rack-mounted server, I will +migrate Plex and Syncthing over to Alpine as well - possibly putting +Plex into a container or VM. + +The performance is stellar, the `apk` package manager is +seamless, and system administration tasks are effortless. My only regret +is that I didn't install Alpine sooner. diff --git a/content/blog/2022-10-30-linux-display-manager.md b/content/blog/2022-10-30-linux-display-manager.md new file mode 100644 index 0000000..b1d9417 --- /dev/null +++ b/content/blog/2022-10-30-linux-display-manager.md @@ -0,0 +1,81 @@ ++++ +date = 2022-10-30 +title = "How to Disable or Change the Display Manager on Void Linux" +description = "Learn how to remove or modify the display manager on Void Linux." ++++ + +## Display Manager Services + +In order to change the [display +manager](https://en.wikipedia.org/wiki/Display_manager) on Void Linux - +or any other Linux distro - you need to identify the currently enabled +display manager. + +### Disabling the Current Display Manager + +Void Linux only has one ISO available for download with a pre-built +display manager at the time of this post: the XFCE ISO. If you've +installed this version, the pre-assigned display manager is +`lxdm`. If you installed another display manager, replace +`lxdm` in the following command with the display manager you +have installed. + +To disable `lxdm`, simply remove the service symlink: + +```sh +sudo rm /var/service/lxdm +``` + +### Enabling a New Display Manager + +If you want to enable a new display manager, you can do so after +`lxdm` is disabled. Make sure to replace +`<new_display_manager>` with your new DM, such as +`gdm`, `xdm`, etc. + +```sh +sudo ln -s /etc/sv/<new_display_manager> /var/service +``` + +## Set Up `.xinitrc` + +Depending on your setup, you may need to create a few X files, such as +`~/.xinitrc`. For my personal set-up, I created this file to +launch the i3wm as my desktop. + +```sh +nano ~/.xinitrc +``` + +```sh +#!/bin/sh + +exec i3 +``` + +If you run a desktop other than i3, simply replace `i3` with +the shell command that launches that desktop. + +## Set Up Your Shell Profile + +Finally, in order to automatically launch an X session upon login, you +will need to edit the `.bash_profile` (bash) or +`.zprofile` (zsh) files for your shell: + +```sh +nano ~/.zprofile +``` + +Add the following snippet to the end of the shell profile file. This +will execute the `startx` command upon login. + +```sh +if [ -z "${DISPLAY}" ] && [ "${XDG_VTNR}" -eq 1 ]; then + exec startx +fi +``` + +Alternatively, you can ignore this step and simply choose to manually +execute `startx` upon login. This can be useful if you have +issues with your desktop or like to manually launch different desktops +by choice. diff --git a/blog/2022-11-07-matrix-synapse.org b/content/blog/2022-11-07-matrix-synapse.md index 493957a..28a8200 100644 --- a/blog/2022-11-07-matrix-synapse.org +++ b/content/blog/2022-11-07-matrix-synapse.md @@ -1,114 +1,106 @@ -#+title: Self-Hosting Matrix Synapse on Alpine Linux -#+date: 2022-11-07 ++++ +date = 2022-11-07 +title = "Self-Hosting Matrix Synapse on Alpine Linux" +description = "A guide to self-hosting the Matrix Synapse application on your own server." ++++ + +## Synpase -** Synpase -:PROPERTIES: -:CUSTOM_ID: synpase -:END: If you're reading this, you likely know that -[[https://github.com/matrix-org/synapse/][Synapse]] is a popular -[[https://matrix.org/][Matrix]] home server software that allows users -to run their own Matrix home server. +[Synapse](https://github.com/matrix-org/synapse/) is a popular +[Matrix](https://matrix.org/) home server software that allows users to +run their own Matrix home server. This post is a short guide describing how I was able to get Synapse working in a minimally-usable state on Alpine Linux. -** Installation Process -:PROPERTIES: -:CUSTOM_ID: installation-process -:END: -*** Dependencies -:PROPERTIES: -:CUSTOM_ID: dependencies -:END: +## Installation Process + +### Dependencies + First, since there is no Alpine-specific package for Synapse, we need to ensure that Alpine has the required dependencies for the Python-based installation method. -#+begin_src sh +```sh doas apk -U update doas apk add python3 py3-virtualenv -#+end_src +``` Next, we need to set up a Python virtual environment for Synapse: -#+begin_src sh +```sh mkdir -p ~/synapse && cd ~/synapse virtualenv -p python3 ~/synapse/env source ~/synapse/env/bin/activate pip install --upgrade pip pip install --upgrade setuptools pip install matrix-synapse -#+end_src +``` + +### Running Synapse -*** Running Synapse -:PROPERTIES: -:CUSTOM_ID: running-synapse -:END: Once installed, running Synapse is easy. Simply execute the following -command, replacing =example.com= with the domain name that will be used -with this home server. This will generate the configuration files needed -to run the server. +command, replacing `example.com` with the domain name that +will be used with this home server. This will generate the configuration +files needed to run the server. -#+begin_src sh +```sh python -m synapse.app.homeserver \ --server-name example.com \ --config-path homeserver.yaml \ --generate-config \ --report-stats=no -#+end_src +``` Once the configuration is generated, we can start up the Synapse server: -#+begin_src sh +```sh synctl start -#+end_src +``` + +### Configuring Synapse -*** Configuring Synapse -:PROPERTIES: -:CUSTOM_ID: configuring-synapse -:END: -To make any change to Synapse, we need to edit the =YAML= configuration -file: +To make any change to Synapse, we need to edit the `YAML` +configuration file: -#+begin_src sh +```sh nano ~/synapse/homeserver.yaml -#+end_src +``` -For now, we just need to ensure the =server_name= is accurate. However, -there are a lot of other configuration options found in the -[[https://matrix-org.github.io/synapse/develop/usage/configuration/config_documentation.html][Configuring -Synapse]] documentation that can be enabled/disabled at any point. +For now, we just need to ensure the `server_name` is +accurate. However, there are a lot of other configuration options found +in the [Configuring +Synapse](https://matrix-org.github.io/synapse/develop/usage/configuration/config_documentation.html) +documentation that can be enabled/disabled at any point. -#+begin_src yaml +```yaml server_name: "example.com" -#+end_src +``` Make sure to restart Synapse when you make changes to the configuration: -#+begin_src sh +```sh synctl restart -#+end_src +``` + +### Nginx Reverse-Proxy -*** Nginx Reverse-Proxy -:PROPERTIES: -:CUSTOM_ID: nginx-reverse-proxy -:END: To ensure that Synapse is reachable from the public, we need to connect our domain to the Synapse server. In my case, I use a Nginx reverse-proxy for this purpose. To use Nginx, we need to create a reverse-proxy configuration file: -#+begin_src sh +```sh doas nano /etc/nginx/http.d/example.com.conf -#+end_src +``` -If you already have TLS certificates for this domain (=example.com=), -you can simply use the SSL configuration and point toward your TLS -certificates. +If you already have TLS certificates for this domain +(`example.com`), you can simply use the SSL configuration and +point toward your TLS certificates. -#+begin_src conf +```conf server { listen 443 ssl http2; listen [::]:443 ssl http2; @@ -147,15 +139,15 @@ server { listen 80; return 404; } -#+end_src +``` If you need to generate TLS certificates (I recommend -[[https://certbot.eff.org/][Certbot]]), you'll need a more minimal Nginx +[Certbot](https://certbot.eff.org/)), you'll need a more minimal Nginx conf file before you can use the TLS-enabled example above. Instead, use this configuration file during the Certbot certificate generation process: -#+begin_src conf +```conf server { server_name example.com; location / { @@ -163,66 +155,64 @@ server { } listen 80; } -#+end_src +``` Once you're done editing the Nginx conf file, restart Nginx: -#+begin_src sh +```sh doas rc-service nginx restart -#+end_src +``` -If you still need to generate TLS certificates, run =certbot= now and -obtain the certificates. Certbot will ask if you want to use a webroot -or spin up a temporary web server. I *highly* recommend using the -temporary web server due to the many issues with using a webroot. +If you still need to generate TLS certificates, run `certbot` +now and obtain the certificates. Certbot will ask if you want to use a +webroot or spin up a temporary web server. I **highly** recommend using +the temporary web server due to the many issues with using a webroot. You will need to stop Nginx in order to user the temporary web server option with Certbot: -#+begin_src sh +```sh # Stop Nginx so certbot can spin up a temp webserver for cert generation doas rc-service nginx stop doas certbot certonly -v doas rc-service nginx start -#+end_src - -*** Open Firewall & Router Ports -:PROPERTIES: -:CUSTOM_ID: open-firewall-router-ports -:END: -If you use a firewall on the server, open the =8448= port for discovery -and federation, as well as the normal web server ports if you're using a -reverse proxy. If you want additional services, such as voice calls, you -will need to read the Synapse documentation to see which ports need to -be opened for those features. +``` + +### Open Firewall & Router Ports + +If you use a firewall on the server, open the `8448` port for +discovery and federation, as well as the normal web server ports if +you're using a reverse proxy. If you want additional services, such as +voice calls, you will need to read the Synapse documentation to see +which ports need to be opened for those features. Here's an example of the Universal Firewall (UFW) software: -#+begin_src sh +```sh # Matrix port doas ufw allow 8448 # Standard web server ports doas ufw allow "Nginx Full" -#+end_src +``` + +Remember to forward any Synapse ports, such as `8448`, +`80`, and `443`, in your Router from the internet +to your server's IP address. -Remember to forward any Synapse ports, such as =8448=, =80=, and =443=, -in your Router from the internet to your server's IP address. +### Adding Matrix Users -*** Adding Matrix Users -:PROPERTIES: -:CUSTOM_ID: adding-matrix-users -:END: Finally, if you didn't enable public registration in the -=homeserver.yaml= file, you can manually create users via the +`homeserver.yaml` file, you can manually create users via the command-line: -#+begin_src sh +```sh cd ~/synapse register_new_matrix_user -c homeserver.yaml -#+end_src +``` Remember that the format for federated Matrix usernames is -=@username:example.com= when logging in to client applications. +`@username:example.com` when logging in to client +applications. Once Synapse is running, and you have a username, you are ready to log in to a Matrix client and start sending messages, joining rooms, and diff --git a/blog/2022-11-11-nginx-tmp-errors.org b/content/blog/2022-11-11-nginx-tmp-errors.md index 2aaf82d..e1a3f36 100644 --- a/blog/2022-11-11-nginx-tmp-errors.org +++ b/content/blog/2022-11-11-nginx-tmp-errors.md @@ -1,13 +1,14 @@ -#+title: Fixing Permission Errors in /var/lib/nginx" description -#+date: 2022-11-11 ++++ +date = 2022-11-11 +title = "Fixing Permission Errors in /var/lib/nginx" +description = "Learn how to fix permission errors related to the Nginx temporary file storage." ++++ -/This is a brief post so that I personally remember the solution as it -has occurred multiple times for me./ +*This is a brief post so that I personally remember the solution as it +has occurred multiple times for me.* + +## The Problem -** The Problem -:PROPERTIES: -:CUSTOM_ID: the-problem -:END: After migrating to a new server OS, I started receiving quite a few permission errors like the one below. These popped up for various different websites I'm serving via Nginx on this server, but did not @@ -15,47 +16,46 @@ prevent the website from loading. I found the errors in the standard log file: -#+begin_src sh +```sh cat /var/log/nginx/error.log -#+end_src +``` -#+begin_src sh +```sh 2022/11/11 11:30:34 [crit] 8970#8970: *10 open() "/var/lib/nginx/tmp/proxy/3/00/0000000003" failed (13: Permission denied) while reading upstream, client: 169.150.203.10, server: cyberchef.example.com, request: "GET /assets/main.css HTTP/2.0", upstream: "http://127.0.0.1:8111/assets/main.css", host: "cyberchef.example.com", referrer: "https://cyberchef.example.com/" -#+end_src +``` -You can see that the error is =13: Permission denied= and it occurs in -the =/var/lib/nginx/tmp/= directory. In my case, I had thousands of -errors where Nginx was denied permission to read/write files in this -directory. +You can see that the error is `13: Permission denied` and it +occurs in the `/var/lib/nginx/tmp/` directory. In my case, I +had thousands of errors where Nginx was denied permission to read/write +files in this directory. So how do I fix it? -** The Solution -:PROPERTIES: -:CUSTOM_ID: the-solution -:END: -In order to resolve the issue, I had to ensure the =/var/lib/nginx= -directory is owned by Nginx. Mine was owned by the =www= user and Nginx -was not able to read or write files within that directory. This -prevented Nginx from caching temporary files. +## The Solution + +In order to resolve the issue, I had to ensure the +`/var/lib/nginx` directory is owned by Nginx. Mine was owned +by the `www` user and Nginx was not able to read or write +files within that directory. This prevented Nginx from caching temporary +files. -#+begin_src sh +```sh # Alpine Linux doas chown -R nginx:nginx /var/lib/nginx # Other Distros sudo chown -R nginx:nginx /var/lib/nginx -#+end_src +``` -You /may/ also be able to change the =proxy_temp_path= in your Nginx -config, but I did not try this. Here's a suggestion I found online that -may work if the above solution does not: +You *may* also be able to change the `proxy_temp_path` in +your Nginx config, but I did not try this. Here's a suggestion I found +online that may work if the above solution does not: -#+begin_src sh +```sh nano /etc/nginx/http.d/example.com.conf -#+end_src +``` -#+begin_src conf +```conf server { ... @@ -65,15 +65,15 @@ server { ... } -#+end_src +``` Finally, restart Nginx and your server should be able to cache temporary files again. -#+begin_src sh +```sh # Alpine Linux (OpenRC) doas rc-service nginx restart # Other Distros (systemd) sudo systemctl restart nginx -#+end_src +``` diff --git a/blog/2022-11-27-server-build.org b/content/blog/2022-11-27-server-build.md index dd3a0b2..f97c9c7 100644 --- a/blog/2022-11-27-server-build.org +++ b/content/blog/2022-11-27-server-build.md @@ -1,10 +1,11 @@ -#+title: Building a Custom Rack-Mount Server -#+date: 2022-11-27 ++++ +date = 2022-11-27 +title = "Building a Custom Rack-Mounted Server" +description = "A retrospective on building my own rack-mounted server." ++++ + +## The Dilemma -** The Dilemma -:PROPERTIES: -:CUSTOM_ID: the-dilemma -:END: For years, I have been using desktops and a Raspberry Pi as the backbone of my homelab. I have always wanted to move toward a single dedicated server that could handle all of my tasks, but was often put off by the @@ -20,37 +21,32 @@ After returning the R720XD, I decided that I wanted to build my own server with modern, consumer-grade PC components. This time, I am very happy with the results of my server. -** Components -:PROPERTIES: -:CUSTOM_ID: components -:END: +## Components + I'll start by listing all the components I used for this server build: -- *Case*: - [[https://www.rosewill.com/rosewill-rsv-r4100u-black/p/9SIA072GJ92825][Rosewill - RSV-R4100U 4U Server Chassis Rackmount Case]] -- *Motherboard*: [[https://nzxt.com/product/n7-b550][NZXT B550]] -- *CPU*: AMD Ryzen 7 5700G with Radeon Graphics -- *GPU*: N/A - I specifically chose one of the few AMD CPUs that support - onboard graphics. -- *RAM*: 64GB RAM (2x32GB) /Max of 128GB RAM on this motherboard/ -- *Boot Drive*: Western Digital 500GB M.2 NVME SSD -- *HDD Bay*: - - 10TB WD White /(shucked, moved from previous server)/ - - 8TB WD White /(shucked, moved from previous server)/ - - 2 x 8TB WD Red Plus /(Black Friday lined up perfectly with this - build, so I grabbed two of these)/ -- *PSU*: Corsair RM850 PSU -- *Extras*: - - Corsair TM3Q Thermal Paste - - Noctua 120mm fan /(replacement for front case fan)/ - - 2 x Noctua 80mm fans /(replacement for rear case fans)/ - - CableMatters 6Gbps SATA Cables - -** Building the Server -:PROPERTIES: -:CUSTOM_ID: building-the-server -:END: +- **Case**: [Rosewill RSV-R4100U 4U Server Chassis Rackmount + Case](https://www.rosewill.com/rosewill-rsv-r4100u-black/p/9SIA072GJ92825) +- **Motherboard**: [NZXT B550](https://nzxt.com/product/n7-b550) +- **CPU**: AMD Ryzen 7 5700G with Radeon Graphics +- **GPU**: N/A - I specifically chose one of the few AMD CPUs that + support onboard graphics. +- **RAM**: 64GB RAM (2x32GB) *Max of 128GB RAM on this motherboard* +- **Boot Drive**: Western Digital 500GB M.2 NVME SSD +- **HDD Bay**: + - 10TB WD White *(shucked, moved from previous server)* + - 8TB WD White *(shucked, moved from previous server)* + - 2 x 8TB WD Red Plus *(Black Friday lined up perfectly with this + build, so I grabbed two of these)* +- **PSU**: Corsair RM850 PSU +- **Extras**: + - Corsair TM3Q Thermal Paste + - Noctua 120mm fan *(replacement for front case fan)* + - 2 x Noctua 80mm fans *(replacement for rear case fans)* + - CableMatters 6Gbps SATA Cables + +## Building the Server + This took quite a while for me to build (in my opinion of time), totaling around 3 hours from start to finish. The case has some peculiar construction, so you have to completely remove the ODD & HDD cages to @@ -59,8 +55,8 @@ install the motherboard and other components first. Now, I've never built a computer of any kind before, so I was quite nervous. Personally, the only challenging part was getting the CPU cooler to screw into the motherboard without sliding the thermal paste -around too much underneath. I'm still not entirely sure if I did a great -job of it, but nothing's broken yet. +around too much underneath. I'm still not entirely sure if I did a +great job of it, but nothing's broken yet. The main components were all fine and simple. However, installing the hard drives is slightly tedious as I need to power off the server and @@ -72,19 +68,15 @@ used to in other machines. Seeing that the cases with hot-swap bays were 3-4x the price, I'm okay dealing with the tedium of removing the cage to install new drives. -** Software -:PROPERTIES: -:CUSTOM_ID: software -:END: +## Software + I'm not going to dive into the software as I have done so in other recent posts. However, I wanted to note that I am using Alpine Linux on this server and hosting most services inside Docker. No virtual machines (VMs) and very few bare-metal services. -** The Results -:PROPERTIES: -:CUSTOM_ID: the-results -:END: +## The Results + How did my build turn out? Well, after migrating my other servers and their services over, I found that my server is blazing fast. The heaviest of my applications, Plex, is handled with ease. Even 4k @@ -94,10 +86,8 @@ I am very happy with the results and will likely continue to improve on this server as the years go by rather than buying another used server online. -*** Mistakes I Made -:PROPERTIES: -:CUSTOM_ID: mistakes-i-made -:END: +### Mistakes I Made + This post wouldn't be complete unless I wrote about the mistakes I made while building. The only real mistake I made beyond a "whoops I dropped a screw" related to airflow and fan direction. @@ -106,19 +96,19 @@ While installing the two new hard drives that showed up on 2022-11-30 and getting ready to install the case in my rack, I noticed that the hard drive temperatures were quite high. -I used the =smartctl= command for each of my drives (=/dev/sda= through -=/dev/sdd=): +I used the `smartctl` command for each of my drives +(`/dev/sda` through `/dev/sdd`): -#+begin_src sh +```sh doas smartctl -a /dev/sda | grep Temperature_Celsius -#+end_src +``` -The results were unusual - all four drives were idling at ~44-46 degrees -Celsius. The only drive that was cooler was my 10TB drive, which was at -38 degrees Celsius. I noted that this 10TB drive was also closest to the -case fan. +The results were unusual - all four drives were idling at ~44-46 +degrees Celsius. The only drive that was cooler was my 10TB drive, which +was at 38 degrees Celsius. I noted that this 10TB drive was also closest +to the case fan. -#+begin_src sh +```sh ID# ATTRIBUTE_NAME FLAG VALUE WORST THRESH TYPE UPDATED WHEN_FAILED RAW_VALUE # /dev/sda 194 Temperature_Celsius 0x0002 147 147 000 Old_age Always - 44 (Min/Max 22/46) @@ -128,7 +118,7 @@ ID# ATTRIBUTE_NAME FLAG VALUE WORST THRESH TYPE UPDATED WHEN_ 194 Temperature_Celsius 0x0002 144 144 000 Old_age Always - 45 (Min/Max 19/61) # /dev/sdd 194 Temperature_Celsius 0x0002 171 171 000 Old_age Always - 38 (Min/Max 14/56) -#+end_src +``` After looking to see if I could fit more fans into the case, I noticed that the 120mm fan used for intake from the front of the case was @@ -140,7 +130,7 @@ dropped immediately! They are now idling at ~31-33 degrees Celsius. A single fan spinning the wrong way caused my drives to idle 10-15 degrees higher than they should have. -#+begin_src sh +```sh ID# ATTRIBUTE_NAME FLAG VALUE WORST THRESH TYPE UPDATED WHEN_FAILED RAW_VALUE # /dev/sda 194 Temperature_Celsius 0x0002 209 209 000 Old_age Always - 31 (Min/Max 14/56) @@ -150,7 +140,7 @@ ID# ATTRIBUTE_NAME FLAG VALUE WORST THRESH TYPE UPDATED WHEN_ 194 Temperature_Celsius 0x0002 203 203 000 Old_age Always - 32 (Min/Max 21/48) # /dev/sdd 194 Temperature_Celsius 0x0002 196 196 000 Old_age Always - 33 (Min/Max 22/46) -#+end_src +``` This was a silly error to make, but I'm glad I found it today before I screwed the case into the rack and made things a lot more tedious to diff --git a/blog/2022-11-29-nginx-referrer-ban-list.org b/content/blog/2022-11-29-nginx-referrer-ban-list.md index 6eb8ad8..ea62722 100644 --- a/blog/2022-11-29-nginx-referrer-ban-list.org +++ b/content/blog/2022-11-29-nginx-referrer-ban-list.md @@ -1,24 +1,25 @@ -#+title: Creating a Referrer Ban List on Nginx -#+date: 2022-11-29 ++++ +date = 2022-11-29 +title = "Creating a Referrer Ban List in Nginx" +description = "Learn how to create a ban list for referring sites in Nginx." ++++ + +## Creating the Ban List -** Creating the Ban List -:PROPERTIES: -:CUSTOM_ID: creating-the-ban-list -:END: In order to ban list referral domains or websites with Nginx, you need to create a ban list file. The file below will accept regexes for different domains or websites you wish to block. First, create the file in your nginx directory: -#+begin_src sh +```sh doas nano /etc/nginx/banlist.conf -#+end_src +``` Next, paste the following contents in and fill out the regexes with whichever domains you're blocking. -#+begin_src conf +```conf # /etc/nginx/banlist.conf map $http_referer $bad_referer { @@ -29,23 +30,21 @@ map $http_referer $bad_referer { # Put regexes for undesired referrers here "~news.ycombinator.com" 1; } -#+end_src +``` + +## Configuring Nginx -** Configuring Nginx -:PROPERTIES: -:CUSTOM_ID: configuring-nginx -:END: In order for the ban list to work, Nginx needs to know it exists and how -to handle it. For this, edit the =nginx.conf= file. +to handle it. For this, edit the `nginx.conf` file. -#+begin_src sh +```sh doas nano /etc/nginx/nginx.conf -#+end_src +``` -Within this file, find the =http= block and add your ban list file -location to the end of the block. +Within this file, find the `http` block and add your ban list +file location to the end of the block. -#+begin_src conf +```conf # /etc/nginx/nginx.conf http { @@ -54,31 +53,30 @@ http { # Include ban list include /etc/nginx/banlist.conf; } -#+end_src +``` + +## Enabling the Ban List -** Enabling the Ban List -:PROPERTIES: -:CUSTOM_ID: enabling-the-ban-list -:END: Finally, we need to take action when a bad referral site is found. To do so, edit the configuration file for your website. For example, I have -all website configuration files in the =http.d= directory. You may have -them in the =sites-available= directory on some distributions. +all website configuration files in the `http.d` directory. +You may have them in the `sites-available` directory on some +distributions. -#+begin_src sh +```sh doas nano /etc/nginx/http.d/example.com.conf -#+end_src +``` -Within each website's configuration file, edit the =server= blocks that -are listening to ports 80 and 443 and create a check for the -=$bad_referrer= variable we created in the ban list file. +Within each website's configuration file, edit the `server` +blocks that are listening to ports 80 and 443 and create a check for the +`$bad_referrer` variable we created in the ban list file. -If a matching site is found, you can return any -[[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes][HTTP Status -Code]] you want. Code 403 (Forbidden) is logical in this case since you -are preventing a client connection due to a banned domain. +If a matching site is found, you can return any [HTTP Status +Code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) you want. +Code 403 (Forbidden) is logical in this case since you are preventing a +client connection due to a banned domain. -#+begin_src conf +```conf server { ... @@ -86,49 +84,45 @@ server { if ($bad_referer) { return 403; } - + ... } -#+end_src +``` + +## Restart Nginx -** Restart Nginx -:PROPERTIES: -:CUSTOM_ID: restart-nginx -:END: Lastly, restart Nginx to enable all changes made. -#+begin_src sh +```sh doas rc-service nginx restart -#+end_src +``` + +## Testing Results -** Testing Results -:PROPERTIES: -:CUSTOM_ID: testing-results -:END: In order to test the results, let's curl the contents of our site. To start, I'll curl the site normally: -#+begin_src sh +```sh curl https://cleberg.net -#+end_src +``` The HTML contents of the page come back successfully: -#+begin_src html +```html <!doctype html>...</html> -#+end_src +``` Next, let's include a banned referrer: -#+begin_src sh +```sh curl --referer https://news.ycombinator.com https://cleberg.net -#+end_src +``` -This time, I'm met with a 403 Forbidden response page. That means we are -successful and any clients being referred from a banned domain will be -met with this same response code. +This time, I'm met with a 403 Forbidden response page. That means we +are successful and any clients being referred from a banned domain will +be met with this same response code. -#+begin_src html +```html <html> <head><title>403 Forbidden</title></head> <body> @@ -136,4 +130,4 @@ met with this same response code. <hr><center>nginx</center> </body> </html> -#+end_src +``` diff --git a/content/blog/2022-12-01-nginx-compression.md b/content/blog/2022-12-01-nginx-compression.md new file mode 100644 index 0000000..9341e19 --- /dev/null +++ b/content/blog/2022-12-01-nginx-compression.md @@ -0,0 +1,79 @@ ++++ +date = 2022-12-01 +title = "Enable GZIP Compression in Nginx" +description = "Learn how to enable compression in Nginx." ++++ + +## Text Compression + +Text compression allows a web server to serve text-based resources +faster than uncompressed data. This can speed up things like First +Contentful Paint, Tie to Interactive, and Speed Index. + +## Enable Nginx Compression with gzip + +In order to enable text compression on Nginx, we need to enable it +within the configuration file: + +```sh +nano /etc/nginx/nginx.conf +``` + +Within the `http` block, find the section that shows +something like the block below. This is the default gzip configuration I +found in my `nginx.conf` file on Alpine Linux 3.17. Yours may +look slightly different, just make sure that you're not creating any +duplicate gzip options. + +```conf +# Enable gzipping of responses. +#gzip on; + +# Set the Vary HTTP header as defined in the RFC 2616. Default is 'off'. +gzip_vary on; +``` + +Remove the default gzip lines and replace them with the following: + +```conf +# Enable gzipping of responses. +gzip on; +gzip_vary on; +gzip_min_length 10240; +gzip_proxied expired no-cache no-store private auth; +gzip_types text/plain text/css text/xml text/javascript application/x-javascript application/xml; +gzip_disable "MSIE [1-6]"; +``` + +## Explanations of ngx~httpgzipmodule~ Options + +Each of the lines above enables a different aspect of the gzip response +for Nginx. Here are the full explanations: + +- `gzip` -- Enables or disables gzipping of responses. +- `gzip_vary` -- Enables or disables inserting the "Vary: + Accept-Encoding" response header field if the directives gzip, + gzip~static~, or gunzip are active. +- `gzip_min_length` -- Sets the minimum length of a + response that will be gzipped. The length is determined only from + the "Content-Length" response header field. +- `gzip_proxied` -- Enables or disables gzipping of + responses for proxied requests depending on the request and + response. The fact that the request is proxied is determined by the + presence of the "Via" request header field. +- `gzip_types` -- Enables gzipping of responses for the + specified MIME types in addition to "text/html". The special value + "*" matches any MIME type (0.8.29). Responses with the + "text/html" type are always compressed. +- `gzip_disable` -- Disables gzipping of responses for + requests with "User-Agent" header fields matching any of the + specified regular expressions. + - The special mask "msie6" (0.7.12) corresponds to the regular + expression "MSIE [4-6].", but works faster. Starting from + version 0.8.11, "MSIE 6.0; ... SV1" is excluded from this + mask. + +More information on these directives and their options can be found on +the [Module +ngx~httpgzipmodule~](https://nginx.org/en/docs/http/ngx_http_gzip_module.html) +page in Nginx's documentation. diff --git a/blog/2022-12-07-nginx-wildcard-redirect.org b/content/blog/2022-12-07-nginx-wildcard-redirect.md index 81b12bc..db1830e 100644 --- a/blog/2022-12-07-nginx-wildcard-redirect.org +++ b/content/blog/2022-12-07-nginx-wildcard-redirect.md @@ -1,10 +1,11 @@ -#+title: Redirect Nginx Subdomains & Trailing Content with Regex -#+date: 2022-12-07 ++++ +date = 2022-12-07 +title = "Redirect Nginx Subdomains & Trailing Content with Regex" +description = "A simple Nginx configuration to redirect all subdomains and trailing content." ++++ + +## Problem -** Problem -:PROPERTIES: -:CUSTOM_ID: problem -:END: I recently migrated domains and replaced the old webpage with a simple info page with instructions to users on how to edit their bookmarks and URLs to get to the page they were seeking. @@ -12,15 +13,13 @@ URLs to get to the page they were seeking. This was not ideal as it left the work up to the user and may have caused friction for users who accessed my RSS feed. -** Solution -:PROPERTIES: -:CUSTOM_ID: solution -:END: +## Solution + Instead, I finally found a solution that allows me to redirect both subdomains AND trailing content. For example, both of these URLs now redirect properly using the logic I'll explain below: -#+begin_src txt +```txt # Example 1 - Simple base domain redirect with trailing content https://domain1.com/blog/alpine-linux/ -> https://domain2.com/blog/alpine-linux/ @@ -28,25 +27,23 @@ https://domain1.com/blog/alpine-linux/ -> https://domain2.com/blog/alpine-linux/ https://libreddit.domain1.com/r/history/comments/7z8cbg/new_discovery_mode_turns_video_game_assassins/ -> https://libreddit.domain2.com/r/history/comments/7z8cbg/new_discovery_mode_turns_video_game_assassins/ -#+end_src +``` Go ahead, try the URLs if you want to test them. -*** Nginx Config -:PROPERTIES: -:CUSTOM_ID: nginx-config -:END: +### Nginx Config + To make this possible. I needed to configure a proper redirect scheme in my Nginx configuration. -#+begin_src sh +```sh doas nano /etc/nginx/http.d/domain1.conf -#+end_src +``` Within this file, I had one block configured to redirect HTTP requests to HTTPS for the base domain and all subdomains. -#+begin_src conf +```conf server { listen [::]:80; listen 80; @@ -62,14 +59,14 @@ server { return 404; } -#+end_src +``` -For the base domain, I have another =server= block dedicated to -redirecting all base domain requests. You can see that the =rewrite= -line is instructing Nginx to gather all trailing content and append it -to the new =domain2.com= URL. +For the base domain, I have another `server` block dedicated +to redirecting all base domain requests. You can see that the +`rewrite` line is instructing Nginx to gather all trailing +content and append it to the new `domain2.com` URL. -#+begin_src conf +```conf server { listen [::]:443 ssl http2; listen 443 ssl http2; @@ -81,21 +78,23 @@ server { ssl_certificate /etc/letsencrypt/live/domain1.com/fullchain.pem; ssl_certificate_key /etc/letsencrypt/live/domain1.com/privkey.pem; } -#+end_src +``` Finally, the tricky part is figuring out how to tell Nginx to redirect while keeping both a subdomain and trailing content intact. I found that -the easiest way to do this is to give it a =server= block of its own. +the easiest way to do this is to give it a `server` block of +its own. -Within this block, we need to do some regex on the =server_name= line -before we can rewrite anything. This creates a variable called -=subdomain=. +Within this block, we need to do some regex on the +`server_name` line before we can rewrite anything. This +creates a variable called `subdomain`. -Once the server gets to the =rewrite= line, it pulls the =subdomain= -variable from above and uses it on the new =domain2.com= domain before -appending the trailing content (=$request_uri=). +Once the server gets to the `rewrite` line, it pulls the +`subdomain` variable from above and uses it on the new +`domain2.com` domain before appending the trailing content +(`$request_uri`). -#+begin_src conf +```conf server { listen [::]:443 ssl http2; listen 443 ssl http2; @@ -107,14 +106,14 @@ server { ssl_certificate /etc/letsencrypt/live/domain1.com/fullchain.pem; ssl_certificate_key /etc/letsencrypt/live/domain1.com/privkey.pem; } -#+end_src +``` That's all there is to it. With this, I simply restarted Nginx and watched the redirections work in-action. -#+begin_src sh +```sh doas rc-service nginx restart -#+end_src +``` Looking back on it, I wish I had done this sooner. Who knows how many people went looking for my sites or bookmarks and gave up when they saw diff --git a/content/blog/2022-12-17-st.md b/content/blog/2022-12-17-st.md new file mode 100644 index 0000000..557d565 --- /dev/null +++ b/content/blog/2022-12-17-st.md @@ -0,0 +1,94 @@ ++++ +date = 2022-12-17 +title = "Simple Terminal" +description = "Instructions for building simple terminal on Fedora." ++++ + +## st + +[st](https://st.suckless.org) standards for Simple Terminal, a simple +terminal implementation for X made by the +[suckless](https://suckless.org) team. + +This post walks through the dependencies needed and process to build and +install `st` on Fedora Workstation. + +### Obtain Files + +To start, obtain the source files for `st` via +`git clone`. + +```sh +mkdir ~/suckless && cd ~/suckless +git clone https://git.suckless.org/st && cd st +``` + +### Dependencies + +Once you have the files and are in the `st` directory, ensure +the following packages are installed. + +```sh +sudo dnf update && sudo dnf upgrade +sudo dnf install gcc patch libX11-devel libXft-devel +``` + +### Building + +Before building, ensure that you read the README file. + +```sh +cat README +``` + +Once you've read the instructions, open the `config.mk` file +and ensure it matches your setup. If you're not sure, leave the default +options within the file. + +Finally, you can build `st` with the following command. +Ensure you run as root (e.g., `sudo`) or else you may not end +up with a usable application file. + +```sh +sudo make clean install +``` + +### Customization (Patches) + +Note that customizing `st` requires you to modify the source +files or to download one of the [available +patches](https://st.suckless.org/patches/) for suckless.org. + +If you've already installed `st` and want to customize or +install a patch, start by uninstalling the current program. + +```sh +cd ~/suckless/st +sudo make uninstall +``` + +Next, grab the `<path>.diff` file from the page of the patch +you chose. For example, I will be using the +[defaultfontsize](https://st.suckless.org/patches/defaultfontsize/) +patch in the below example. + +```sh +wget https://st.suckless.org/patches/defaultfontsize/st-defaultfontsize-20210225-4ef0cbd.diff +``` + +Once the file is downloaded inside the `st` folder, apply the +patch and re-install the program. You may need to install the +`patch` command if you don't have it installed already (you +should have installed it above). + +```sh +patch -i st-defaultfontsize-20210225-4ef0cbd.diff +sudo make clean install +``` + +Once installed, you can use the default font size patch to launch +`st` with any font size you wish: + +```sh +st -z 16 +``` diff --git a/blog/2022-12-23-alpine-desktop.org b/content/blog/2022-12-23-alpine-desktop.md index 8967da7..a595e17 100644 --- a/blog/2022-12-23-alpine-desktop.org +++ b/content/blog/2022-12-23-alpine-desktop.md @@ -1,10 +1,11 @@ -#+title: Alpine Linux as a Desktop OS -#+date: 2022-12-23 ++++ +date = 2022-12-23 +title = "Alpine Linux as a Desktop OS" +description = "Learn how to set up Alpine Linux with Sway to use as a desktop operating system." ++++ + +## Isn't Alpine Linux for Servers? -** Isn't Alpine Linux for Servers? -:PROPERTIES: -:CUSTOM_ID: isnt-alpine-linux-for-servers -:END: This is a question I see a lot when people are presented with an example of Alpine Linux running as a desktop OS. @@ -14,82 +15,76 @@ functioning at a productive level for desktop users. This post is documentation of how I installed and modified Alpine Linux to become my daily desktop OS. -** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: +## Installation + Note that I cover the installation of Alpine Linux in my other post, so -I won't repeat it here: [[/blog/alpine-linux/][Alpine Linux: My New -Server OS]]. +I won't repeat it here: [Alpine Linux: My New Server +OS](/blog/alpine-linux/). Basically, get a bootable USB or whatever you prefer with Alpine on it, boot the ISO, and run the setup script. -#+begin_src sh +```sh setup-alpine -#+end_src +``` Once you have gone through all the options and installer finishes without errors, reboot. -#+begin_src sh +```sh reboot -#+end_src +``` + +## Initial Setup -** Initial Setup -:PROPERTIES: -:CUSTOM_ID: initial-setup -:END: Once Alpine is installed and the machine has rebooted, login is as root -initially or =su= to root once you log in as your user. From here, you -should start by updating and upgrading the system in case the ISO was -not fully up-to-date. +initially or `su` to root once you log in as your user. From +here, you should start by updating and upgrading the system in case the +ISO was not fully up-to-date. -#+begin_src sh +```sh # Update and upgrade system apk -U update && apk -U upgrade # Add an editor so we can enable the community repository apk add nano -#+end_src +``` -You need to uncomment the =community= repository for your version of -Alpine Linux. +You need to uncomment the `community` repository for your +version of Alpine Linux. -For v3.17, the =repositories= file should look like this: +For v3.17, the `repositories` file should look like this: -#+begin_src sh +```sh nano /etc/apk/repositories -#+end_src +``` -#+begin_src conf +```conf #/media/sda/apks http://mirrors.gigenet.com/alpinelinux/v3.17/main http://mirrors.gigenet.com/alpinelinux/v3.17/community #http://mirrors.gigenet.com/alpinelinux/edge/main #http://mirrors.gigenet.com/alpinelinux/edge/community #http://mirrors.gigenet.com/alpinelinux/edge/testing -#+end_src +``` -#+begin_src sh +```sh # Add the rest of your packages apk add linux-firmware iwd doas git curl wget # Add yourself to the wheel group so you can use the doas command adduser $USER wheel -#+end_src +``` -** Window Manager (Desktop) -:PROPERTIES: -:CUSTOM_ID: window-manager-desktop -:END: -The [[https://wiki.alpinelinux.org/wiki/Sway][Sway installation guide]] +## Window Manager (Desktop) + +The [Sway installation guide](https://wiki.alpinelinux.org/wiki/Sway) has everything you need to get Sway working on Alpine. However, I'll include a brief list of the commands I ran and their purpose for posterity here. -#+begin_src sh +```sh # Add eudev and set it up apk add eudev setup-devd udev @@ -126,21 +121,22 @@ apk add \ # Install optional dependencies: swaylock swaylockd \ # lockscreen tool swaybg \ # wallpaper daemon swayidle # idle management (DPMS) daemon -#+end_src +``` Once you have the packages installed and set-up, you need to export the -=XDG_RUNTIME_DIR= upon login. To do this, edit your =.profile= file. +`XDG_RUNTIME_DIR` upon login. To do this, edit your +`.profile` file. -If you use another shell, such as =zsh=, you need to edit that shell's -profile (e.g., =~/.zprofile=)! +If you use another shell, such as `zsh`, you need to edit +that shell's profile (e.g., `~/.zprofile`)! -#+begin_src sh +```sh nano ~/.profile -#+end_src +``` Within the file, paste this: -#+begin_src sh +```sh if test -z "${XDG_RUNTIME_DIR}"; then export XDG_RUNTIME_DIR=/tmp/$(id -u)-runtime-dir if ! test -d "${XDG_RUNTIME_DIR}"; then @@ -148,22 +144,20 @@ if test -z "${XDG_RUNTIME_DIR}"; then chmod 0700 "${XDG_RUNTIME_DIR}" fi fi -#+end_src +``` Once that's complete, you can launch Sway manually. -#+begin_src sh +```sh dbus-run-session -- sway -#+end_src +``` + +## Personal Touches -** Personal Touches -:PROPERTIES: -:CUSTOM_ID: personal-touches -:END: I also added the following packages, per my personal preferences and situation. -#+begin_src sh +```sh doas apk add brightnessctl \ # Brightness controller zsh \ # Shell firefox \ # Browser @@ -173,98 +167,93 @@ doas apk add brightnessctl \ # Brightness controller neomutt \ # CLI email client thunderbird \ # GUI email client gnupg # GPG key manager -#+end_src +``` From here, I use my Syncthing storage to pull all the configuration -files I stored from prior desktops, such as -[[https://git.sr.ht/~cmc/dotfiles][my dotfiles]]. - -** Resolving Issues -:PROPERTIES: -:CUSTOM_ID: resolving-issues -:END: -*** WiFi Issues -:PROPERTIES: -:CUSTOM_ID: wifi-issues -:END: -I initially tried to set up my Wi-Fi the standard way with =iwd=, but it -didn't work. - -Here is what I initially tried (I did all of this as =root=): - -#+begin_src sh +files I stored from prior desktops, such as [my +dotfiles](https://git.sr.ht/~cmc/dotfiles). + +## Resolving Issues + +### WiFi Issues + +I initially tried to set up my Wi-Fi the standard way with +`iwd`, but it didn't work. + +Here is what I initially tried (I did all of this as `root`): + +```sh apk add iwd rc-service iwd start iwctl station wlan0 connect <SSID> # This will prompt for the password rc-update add iwd boot && rc-update add dbus boot -#+end_src +``` Then, I added the Wi-Fi entry to the bottom of the networking interface file: -#+begin_src sh +```sh nano /etc/network/interfaces -#+end_src +``` -#+begin_src conf +```conf auto wlan0 iface wlan0 inet dhcp -#+end_src +``` Finally, restart the networking service: -#+begin_src sh +```sh rc-service networking restart -#+end_src +``` My Wi-Fi interface would receive an IP address from the router, but it could not ping anything in the network. To solve the Wi-Fi issues, I -originally upgraded to Alpine's =edge= repositories, which was -unnecessary. +originally upgraded to Alpine's `edge` repositories, which +was unnecessary. -Really, the solution was to enable the =NameResolvingService=resolvconf= -in =/etc/iwd/main.conf=. +Really, the solution was to enable the +`NameResolvingService=resolvconf` in +`/etc/iwd/main.conf`. -#+begin_src sh +```sh doas nano /etc/iwd/main.conf -#+end_src +``` -#+begin_src conf +```conf [Network] NameResolvingService=resolvconf -#+end_src +``` Once I finished this process, my Wi-Fi is working flawlessly. -*** Sound Issues -:PROPERTIES: -:CUSTOM_ID: sound-issues -:END: +### Sound Issues + Same as with the Wi-Fi, I had no sound and could not control the mute/unmute or volume buttons on my laptop. To resolve this, I installed -[[https://wiki.alpinelinux.org/wiki/PipeWire][pipewire]]. +[pipewire](https://wiki.alpinelinux.org/wiki/PipeWire). -#+begin_src sh +```sh # Add your user to the following groups addgroup $USER audio addgroup $USER video # Install pipewire and other useful packages apk add pipewire wireplumber pipewire-pulse pipewire-jack pipewire-alsa -#+end_src +``` -Finally, I needed to add =/usr/libexec/pipewire-launcher= to my -=.config/sway/config= file so that Pipewire would run every time I -launched sway. +Finally, I needed to add `/usr/libexec/pipewire-launcher` to +my `.config/sway/config` file so that Pipewire would run +every time I launched sway. -#+begin_src sh +```sh nano ~/.config/sway/config -#+end_src +``` -#+begin_src conf +```conf # Run pipewire audio server exec /usr/libexec/pipewire-launcher @@ -273,7 +262,7 @@ bindsym XF86AudioRaiseVolume exec --no-startup-id pactl set-sink-volume @DEFAULT bindsym XF86AudioLowerVolume exec --no-startup-id pactl set-sink-volume @DEFAULT_SINK@ -5% bindsym XF86AudioMute exec --no-startup-id pactl set-sink-mute @DEFAULT_SINK@ toggle bindsym XF86AudioMicMute exec --no-startup-id pactl set-source-mute @DEFAULT_SOURCE@ toggle -#+end_src +``` Note that I do not use bluetooth or screen sharing, so I won't cover those options in this post. diff --git a/blog/2023-01-03-recent-website-changes.org b/content/blog/2023-01-03-recent-website-changes.md index 7a9b309..91126a6 100644 --- a/blog/2023-01-03-recent-website-changes.org +++ b/content/blog/2023-01-03-recent-website-changes.md @@ -1,46 +1,43 @@ -#+title: Recent Website Changes -#+date: 2023-01-03 ++++ +date = 2023-01-03 +title = "Recent Website Changes" +description = "A retrospective of recent changes to my website." ++++ + +## The State of This Website -** The State of This Website -:PROPERTIES: -:CUSTOM_ID: the-state-of-this-website -:END: Over the years, this website has changed URLs, styles, content focus, and much more. However, it seems that I am never done, as I am yet again changing this page to fit my current needs and wants. -While this site was already minimal (~12kb), it contained a lot of +While this site was already minimal (\~12kb), it contained a lot of disorganized content and some poorly chosen color schemes. The recent updates attempt to fix these items while focusing on what I truly care about here: the content within each page. -** Recent Changes -:PROPERTIES: -:CUSTOM_ID: recent-changes -:END: +## Recent Changes + I've made quite a few changes to the style of this website today, both in the CSS and in the HTML. Here are some of the key takeaways from today's changes: -1. Reduce the width of the website from =60em= to =40em=. -2. Remove breadcrumb navigation and replaced with a simple "Return Home" - link when visiting anything other than the homepage. -3. Remove syntax highlighting from code blocks. CSS now loads from a - single file. -4. Move blog posts on the homepage to the top, pushing tertiary content - down. -5. Update font-family from =monospace= to =sans-serif= for readability. - -** Future Focus -:PROPERTIES: -:CUSTOM_ID: future-focus -:END: -*** Accessibility -:PROPERTIES: -:CUSTOM_ID: accessibility -:END: +1. Reduce the width of the website from `60em` to + `40em`. +2. Remove breadcrumb navigation and replaced with a simple "Return + Home" link when visiting anything other than the homepage. +3. Remove syntax highlighting from code blocks. CSS now loads from a + single file. +4. Move blog posts on the homepage to the top, pushing tertiary content + down. +5. Update font-family from `monospace` to + `sans-serif` for readability. + +## Future Focus + +### Accessibility + My main focus amidst all the changes this past year was accessibility. I tried to improve the accessibility of all pages on this site as well as I know how. For example, I added aria labels to identify different @@ -49,10 +46,8 @@ navigation menus in November. I want to continue this in 2023 and learn more about the accessibility features I can utilize to help those who may need them. -*** Content First -:PROPERTIES: -:CUSTOM_ID: content-first -:END: +### Content First + Beyond accessibility, I am making a concerted effort to bring the content of this site to the forefront and push the tertiary information (e.g., About Me, Services, etc.) down below the content. @@ -61,33 +56,30 @@ Further, I want to review and edit previous blog posts for grammar, accuracy, dead links, and more. Where necessary, I may even add a blurb at the top of old posts that are no longer accurate or helpful. -*** Style -:PROPERTIES: -:CUSTOM_ID: style -:END: +### Style + As always, I will be searching for ways to reduce distractions and bring a minimalistic approach to this site. While there are certainly more -drastic measures I could take, such as making this a -[[https://shinobi.bt.ht][Shinobi Website]] or a [[https://nocss.club][No -CSS Website]], I prefer to keep some modern features here. +drastic measures I could take, such as making this a [Shinobi +Website](https://shinobi.bt.ht) or a [No CSS +Website](https://nocss.club), I prefer to keep some modern features +here. Two ideas have been floating around in my head, but I am not sure how I feel about these approaches yet: -1. Going all-in with Emacs org-mode and creating a script to - auto-publish all my blog posts from org-mode to plain HTML files and - then letting my CSS style it after the fact. -2. Focus on publishing for Gemini or Gopher and then utilize a - conversion program to translate the pages to HTML. +1. Going all-in with Emacs org-mode and creating a script to + auto-publish all my blog posts from org-mode to plain HTML files and + then letting my CSS style it after the fact. +2. Focus on publishing for Gemini or Gopher and then utilize a + conversion program to translate the pages to HTML. + +## Looking Back -** Looking Back -:PROPERTIES: -:CUSTOM_ID: looking-back -:END: As I sit here and finalize the changes, as well as this post, I am happy with the current state of this website. It's certainly a long way from -my first attempts (parallax background images, anyone?) and it's good to -see the progress. +my first attempts (parallax background images, anyone?) and it's good +to see the progress. I can only hope and work hard to ensure that I make more meaningful progress by this time next year. diff --git a/blog/2023-01-05-mass-unlike-tumblr-posts.org b/content/blog/2023-01-05-mass-unlike-tumblr-posts.md index ed6a90a..474d503 100644 --- a/blog/2023-01-05-mass-unlike-tumblr-posts.org +++ b/content/blog/2023-01-05-mass-unlike-tumblr-posts.md @@ -1,19 +1,18 @@ -#+title: How to Easily Mass Unlike Tumblr Posts With Javascript -#+date: 2023-01-05 ++++ +date = 2023-01-05 +title = "How to Easily Mass Unlike Tumblr Posts with Javascript" +description = "Learn how to unlike Tumblr posts en masse in the browser." ++++ + +## The Dilemma -** The Dilemma -:PROPERTIES: -:CUSTOM_ID: the-dilemma -:END: The dilemma I had was pretty simple: I wanted to unlike all the posts I have liked on Tumblr so that I could follow a new focus on blogs and start fresh. Otherwise, Tumblr will keep recommending content based on your previous likes. -** The Solution -:PROPERTIES: -:CUSTOM_ID: the-solution -:END: +## The Solution + I searched the web for a while and noted that most solutions referenced Tumblr setting and dashboard pages that no longer exist. Additionally, I did not want to install a third party extension to do this, as some @@ -23,15 +22,13 @@ Luckily, I used Javascript for a while a few years ago and figured it would be easy enough to script a solution, as long as Tumblr had a system for the unlike buttons. -*** Identifying Unlike Buttons -:PROPERTIES: -:CUSTOM_ID: identifying-unlike-buttons -:END: +### Identifying Unlike Buttons + Tumblr's unlike buttons are structured as you can see in the following -code block. All unlike buttons have an =aria-label= with a value of -=Unlike=. +code block. All unlike buttons have an `aria-label` with a +value of `Unlike`. -#+begin_src html +```html <button class="TRX6J" aria-label="Unlike"> <span class="EvhBA B1Z5w ztpfZ" tabindex="-1"> <svg xmlns="http://www.w3.org/2000/svg" height="21" width="23" @@ -40,36 +37,35 @@ code block. All unlike buttons have an =aria-label= with a value of </svg> </span> </button> -#+end_src +``` -*** Running a Script to Unlike All Likes -:PROPERTIES: -:CUSTOM_ID: running-a-script-to-unlike-all-likes -:END: -To run this script, you will need to load the -[[https://www.tumblr.com/likes][Likes | Tumblr]] page while logged in to -your account. +### Running a Script to Unlike All Likes + +To run this script, you will need to load the [Likes \| +Tumblr](https://www.tumblr.com/likes) page while logged in to your +account. Further, be sure to scroll down to the bottom and force Tumblr to load more posts so that this script unlikes more posts at a time. Once you are logged in and the page is loaded, open the Developer Tools -and be sure you're on the "Console" tab. It should look something like -this (this is in Firefox, Chromium should be similar): +and be sure you're on the "Console" tab. It should look something +like this (this is in Firefox, Chromium should be similar): -#+caption: Firefox Dev !Tools -[[https:///img.cleberg.net/blog/20230105-mass-unlike-tumblr-posts/dev_console.png]] + All you need to do is paste the following snippet into the dev console. -This code will collect all unlike buttons (=elements=) and then click -each button to unlike it. +This code will collect all unlike buttons (`elements`) and +then click each button to unlike it. -Optionally, you can comment-out the line =elements[i].click();= and -uncomment the =console.log()= lines to simply print out information -without performing any actions. This can be useful to debug issues or -confirm that the code below isn't doing anything you don't want it to. +Optionally, you can comment-out the line +`elements[i].click();` and uncomment the +`console.log()` lines to simply print out information without +performing any actions. This can be useful to debug issues or confirm +that the code below isn't doing anything you don't want it to. -#+begin_src javascript +```javascript const elements = document.querySelectorAll('[aria-label="Unlike"]'); // console.log(elements); // 👉 [button] @@ -77,22 +73,20 @@ for (let i=0; i < elements.length; i++) { // console.log(elements[i]); elements[i].click(); } -#+end_src +``` + +## Results -** Results -:PROPERTIES: -:CUSTOM_ID: results -:END: -The results were quick for my situation, as it unliked ~200 posts within -2-3 seconds. I am not sure how this will perform on larger sets of likes -(or if Tumblr has a limit to unliking posts). +The results were quick for my situation, as it unliked \~200 posts +within 2-3 seconds. I am not sure how this will perform on larger sets +of likes (or if Tumblr has a limit to unliking posts). You can see the below screenshot showing that I pasted the snippet into the console, pressed Enter, and then the posts are automatically unliked. -#+caption: Script !Results -[[https:///img.cleberg.net/blog/20230105-mass-unlike-tumblr-posts/script_results.png]] + Thinking about this further, I would bet that this would be fairly simple to package into a browser add-on so that users could install the diff --git a/blog/2023-01-08-fedora-remove-login-manager.org b/content/blog/2023-01-08-fedora-remove-login-manager.md index eedb47b..e233809 100644 --- a/blog/2023-01-08-fedora-remove-login-manager.org +++ b/content/blog/2023-01-08-fedora-remove-login-manager.md @@ -1,10 +1,11 @@ -#+title: Remove the Login Manager from Fedora i3 -#+date: 2023-01-08 ++++ +date = 2023-01-08 +title = "How to Remove the Login Manager from Fedora i3" +description = "Learn how to completely remove the login manager from Fedora i3." ++++ + +## Fedora i3's Login Manager -** Fedora i3's Login Manager -:PROPERTIES: -:CUSTOM_ID: fedora-i3s-login-manager -:END: Since I use the i3 spin of Fedora Workstation, I don't like to have a login manager installed by default. As of the current version of Fedora i3, the default login manager is LightDM. @@ -13,35 +14,31 @@ If this is no longer the case, you can search for currently-installed packages with the following command and see if you can identify a different login manager. -#+begin_src sh +```sh sudo dnf list installed -#+end_src +``` + +## Removing the Login Manager -** Removing the Login Manager -:PROPERTIES: -:CUSTOM_ID: removing-the-login-manager -:END: In order to remove the login manager, simply uninstall the package. -#+begin_src sh +```sh sudo dnf remove lightdm -#+end_src +``` + +## Launching i3 Manually -** Launching i3 Manually -:PROPERTIES: -:CUSTOM_ID: launching-i3-manually -:END: In order to launch i3 manually, you need to set up your X session -properly. To start, create or edit the =~/.xinitrc= file to include the -following at the bottom. +properly. To start, create or edit the `~/.xinitrc` file to +include the following at the bottom. -#+begin_src config +```config exec i3 -#+end_src +``` Now, whenever you log in to the TTY, you can launch your desktop with the following command. -#+begin_src sh +```sh startx -#+end_src +``` diff --git a/blog/2023-01-21-running-flatpak-apps-easily.org b/content/blog/2023-01-21-running-flatpak-apps-easily.md index 1608eb1..86dd11d 100644 --- a/blog/2023-01-21-running-flatpak-apps-easily.org +++ b/content/blog/2023-01-21-running-flatpak-apps-easily.md @@ -1,50 +1,50 @@ -#+title: Running Flatpak Apps with Symlinks -#+date: 2023-01-21 ++++ +date = 2023-01-21 +title = "Running Flatpak Apps with Symlinks" +description = "Learn how to run Flatpak apps through menu launchers with symlinks." ++++ + +## Running Flatpak Apps Should Be Faster -** Running Flatpak Apps Should Be Faster -:PROPERTIES: -:CUSTOM_ID: running-flatpak-apps-should-be-faster -:END: If you're like me and use Flatpak for those pesky apps that cannot run on your system for one reason or another, you likely get annoyed with opening a terminal and manually running the Flatpak app with the lengthy -=flatpak run ...= command. +`flatpak run ...` command. -In the past, I manually created aliases in my =.zshrc= file for certain -apps. For example, an alias would look like the example below. +In the past, I manually created aliases in my `.zshrc` file +for certain apps. For example, an alias would look like the example +below. This would allow me to run the command fast within the terminal, but it wouldn't allow me to run it in an application launcher. -#+begin_src sh +```sh # ~/.zshrc alias librewolf = "flatpak run io.gitlab.librewolf-community" -#+end_src +``` However, I now use a much faster and better method that integrates with -the tiling WMs I use and their application launchers - =dmenu= and -=bemenu=. +the tiling WMs I use and their application launchers - +`dmenu` and `bemenu`. + +## Creating Symlinks for Flatpak Apps -** Creating Symlinks for Flatpak Apps -:PROPERTIES: -:CUSTOM_ID: creating-symlinks-for-flatpak-apps -:END: Let's use the example of Librewolf below. I can install the application like so: -#+begin_src sh +```sh flatpak install flathub io.gitlab.librewolf-community -#+end_src +``` Once installed, I can create a symlink to link the flatpak app to my new symlink in a location commonly included in your PATH. In this case, I -chose =/usr/bin=. You may need to choose a different location if -=/usr/bin= isn't in your PATH. +chose `/usr/bin`. You may need to choose a different location +if `/usr/bin` isn't in your PATH. -#+begin_src sh +```sh ln -s /var/lib/flatpak/exports/bin/io.gitlab.librewolf-community /usr/bin/librewolf -#+end_src +``` Once complete, you should be able to launch the app using the command -name you chose above in the symlink (=librewolf=) from a terminal or -from your application launcher! +name you chose above in the symlink (`librewolf`) from a +terminal or from your application launcher! diff --git a/blog/2023-01-23-random-mullvad-wireguard.org b/content/blog/2023-01-23-random-mullvad-wireguard.md index c87f05a..e4ba58d 100644 --- a/blog/2023-01-23-random-mullvad-wireguard.org +++ b/content/blog/2023-01-23-random-mullvad-wireguard.md @@ -1,17 +1,17 @@ -#+title: Connecting to a Random Mullvad Wireguard Host -#+date: 2023-01-23 ++++ +date = 2023-01-23 +title = "Connecting to a Random Mullvad Wireguard Host on Boot" +description = "Learn how to connect to a random Mullvad Wireguard host on boot." ++++ + +## Mullvad Wireguard -** Mullvad Wireguard -:PROPERTIES: -:CUSTOM_ID: mullvad-wireguard -:END: If you're using an OS that does not support one of Mullvad's apps, you're likely using the Wireguard configuration files instead. -If not, the first step is to visit Mullvad's -[[https://mullvad.net/en/account/#/wireguard-config][Wireguard -configuration files]] page and download a ZIP of the configuration files -you want to use. +If not, the first step is to visit Mullvad's [Wireguard configuration +files](https://mullvad.net/en/account/#/wireguard-config) page and +download a ZIP of the configuration files you want to use. Personally, I downloaded all configuration files across the world and chose my connections using the script below. @@ -19,31 +19,29 @@ chose my connections using the script below. Once the files are downloaded, unzip them and move them to your preferred location: -#+begin_src sh +```sh cd Downloads unzip mullvad_wireguard_linux_all_all.zip mkdir ~/mullvad && mv ~/Downloads/*.conf ~/mullvad/ -#+end_src +``` + +## Creating a Script to Connect to a Random Host -** Creating a Script to Connect to a Random Host -:PROPERTIES: -:CUSTOM_ID: creating-a-script-to-connect-to-a-random-host -:END: Once you have a folder of Wireguard configuration files from Mullvad, you can create a script to randomly connect to any one of the locations. -Start by creating a shell script - mine is called =vpn.sh=. +Start by creating a shell script - mine is called `vpn.sh`. -#+begin_src sh +```sh nano ~/vpn.sh -#+end_src +``` Within this script, you can paste the following info. Note that I -specify =us-*= in my script, which means that it will only consider -US-based VPN locations. You can alter this or simply change it =*= to -consider all locations. +specify `us-*` in my script, which means that it will only +consider US-based VPN locations. You can alter this or simply change it +`*` to consider all locations. -#+begin_src sh +```sh #!/bin/sh ls /home/$USER/mullvad/us-* |sort -R |tail -n 1 |while read file; do @@ -54,19 +52,19 @@ ls /home/$USER/mullvad/us-* |sort -R |tail -n 1 |while read file; do printf "\n\nPrinting new IP info:\n" curl https://am.i.mullvad.net/connected done -#+end_src +``` Once you've modified the script to your liking, add executable permissions and run the script: -#+begin_src sh +```sh chmod +x ~/vpn.sh ~/vpn.sh -#+end_src +``` The output should look like the following: -#+begin_src txt +```txt doas (user@host) password: # ... The script will process all of the iptables and wg commands here @@ -75,45 +73,44 @@ Created Mullvad wireguard connection with file: /home/user/mullvad/us-nyc-wg-210 Printing new IP info: You are connected to Mullvad (server country-city-wg-num). Your IP address is 12.345.678.99 -#+end_src +``` That's all there is to it. You can see your new location and IP via the -=printf= and =curl= commands included in the script. +`printf` and `curl` commands included in the +script. + +You can also go to the [Connection Check \| +Mullvad](https://mullvad.net/en/check/) page to see if you are fully +connected to Mullvad and if any leaks exist. -You can also go to the [[https://mullvad.net/en/check/][Connection Check -| Mullvad]] page to see if you are fully connected to Mullvad and if any -leaks exist. + -#+caption: Mullvad Connection Check -[[https://img.cleberg.net/blog/20230123-random-mullvad-wireguard/mullvad_check.png]] +## Disconnecting from the Wireguard Connection -** Disconnecting from the Wireguard Connection -:PROPERTIES: -:CUSTOM_ID: disconnecting-from-the-wireguard-connection -:END: If you forget which connection you're using, you can execute the following command to see where Wireguard is currently connected: -#+begin_src sh +```sh wg show -#+end_src +``` This command will show you the Wireguard interfaces and should output a -connection like so: =interface: us-lax-wg-104=. +connection like so: `interface: us-lax-wg-104`. Once you have this, just disconnect using that files' full path: -#+begin_src sh +```sh wg-quick down /home/user/mullvad/us-lax-wg-104.conf -#+end_src +``` I have a TODO item on figuring out how to easily export an environment -variable that contains the configuration file's full name, so that I can -just execute the following: +variable that contains the configuration file's full name, so that I +can just execute the following: -#+begin_src sh +```sh # Ideal situation if I can export the $file variable to the environment wg-quick down $file -#+end_src +``` If you have an idea on how to do this, email me! diff --git a/blog/2023-01-28-self-hosting-wger-workout-manager.org b/content/blog/2023-01-28-self-hosting-wger-workout-manager.md index a4314c3..1f26d3a 100644 --- a/blog/2023-01-28-self-hosting-wger-workout-manager.org +++ b/content/blog/2023-01-28-self-hosting-wger-workout-manager.md @@ -1,118 +1,106 @@ -#+title: Self-Hosting Wger Workout Manager -#+date: 2023-01-28 - -** Wger: The Self-Hosted Workout Manager -:PROPERTIES: -:CUSTOM_ID: wger-the-self-hosted-workout-manager -:END: -[[https://wger.de][Wger Workout Manager]] is a fitness tracking tool for ++++ +date = 2023-01-28 +title = "Self-Hosting Wger Workout Manager" +description = "A guide to self-hosting the Wger application on your own server." ++++ + +## Wger: The Self-Hosted Workout Manager + +[Wger Workout Manager](https://wger.de) is a fitness tracking tool for those who enjoy self-hosting their data. You can also register an account on their main website if you'd prefer to try without self-hosting. -*** Features -:PROPERTIES: -:CUSTOM_ID: features -:END: +### Features + I didn't see a full listing of features anywhere, so I compiled this list of my own after installing wger: -**** Dashboard -:PROPERTIES: -:CUSTOM_ID: dashboard -:END: -- Dashboard view of Workout Schedule, Nutrition Plan, Weight Graph, & - last 5 Weight Logs - -**** Training -:PROPERTIES: -:CUSTOM_ID: training -:END: -- Workout Log -- Workout Schedule -- Calendar (shows weight logs and Bad/Neutral/Good days) -- Gallery (shows images you upload) -- Workout templates -- Public templates -- Exercises - -**** Nutrition -:PROPERTIES: -:CUSTOM_ID: nutrition -:END: -- Nutrition plans -- BMI calculator -- Daily calories calculator -- Ingredient overview - -**** Body Weight -:PROPERTIES: -:CUSTOM_ID: body-weight -:END: -- Weight overview - -*** Documentation -:PROPERTIES: -:CUSTOM_ID: documentation -:END: +1. Dashboard + + - Dashboard view of Workout Schedule, Nutrition Plan, Weight + Graph, & last 5 Weight Logs + +2. Training + + - Workout Log + - Workout Schedule + - Calendar (shows weight logs and Bad/Neutral/Good days) + - Gallery (shows images you upload) + - Workout templates + - Public templates + - Exercises + +3. Nutrition + + - Nutrition plans + - BMI calculator + - Daily calories calculator + - Ingredient overview + +4. Body Weight + + - Weight overview + +### Documentation + In order to self-host wger, I opted to use the Docker version of the application. You can read the README within the -[[https://github.com/wger-project/docker][wger-project/docker]] project -on GitHub for information and installation instructions. +[wger-project/docker](https://github.com/wger-project/docker) project on +GitHub for information and installation instructions. + +### Installation -*** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: To start the installation, I created a folder for wger and started creating the three necessary files: -#+begin_src sh +```sh mkdir ~/wger && mkdir ~/wger/config touch ~/wger/docker-compose.yml && \ touch ~/wger/config/prod.env && \ touch ~/wger/config/nginx.conf -#+end_src +``` Once you have the folders and files created, you will need to copy the -contents of the =docker-compose.yml=, =prod.env=, and =nginx.conf= from -the GitHub link above. +contents of the `docker-compose.yml`, `prod.env`, +and `nginx.conf` from the GitHub link above. A few notes to explain the changes I made to the default files: -- I updated the =ALLOW_REGISTRAION= variable in =prod.env= to =False= - after I created an account via my LAN connection, *before* I connected - this app to a publicly-available domain. -- I uncommented and updated =CSRF_TRUSTED_ORIGINS= to be equal to the - public version of this app: =https://wger.example.com=. -- I updated the port within =docker-compose.yml=, within the =nginx= - block. The port I updated this to will be reflected in my nginx - configuration file on the server (NOT the wger nginx.conf file). - -*** Deploy -:PROPERTIES: -:CUSTOM_ID: deploy -:END: +- I updated the `ALLOW_REGISTRAION` variable in + `prod.env` to `False` after I created an + account via my LAN connection, **before** I connected this app to a + publicly-available domain. +- I uncommented and updated `CSRF_TRUSTED_ORIGINS` to be + equal to the public version of this app: + `https://wger.example.com`. +- I updated the port within `docker-compose.yml`, within + the `nginx` block. The port I updated this to will be + reflected in my nginx configuration file on the server (NOT the wger + nginx.conf file). + +### Deploy + Once all files are created and modified to your needs, simply start the container. -#+begin_src sh +```sh docker-compose up -d -#+end_src +``` You can now visit the website on your LAN by going to -=localhost:YOUR_PORT= or by the server's IP, if you're not on the same -machine that is running the container. +`localhost:YOUR_PORT` or by the server's IP, if you're not +on the same machine that is running the container. If you wish to connect this app to a public domain name, you'll need to -point an =A= DNS record from the domain to your server's public IP. -You'll then need to create a configuration file for whichever web server -or reverse proxy you're using. +point an `A` DNS record from the domain to your server's +public IP. You'll then need to create a configuration file for +whichever web server or reverse proxy you're using. Wger's README suggests the following reverse proxy configuration for Nginx: -#+begin_src conf +```conf upstream wger { # This port should match the port in the `nginx` block of docker-compose.yml # If the container is running on this same machine, replace this with @@ -139,18 +127,16 @@ server { ssl_certificate /path/to/https/certificate.crt; ssl_certificate_key /path/to/https/certificate.key; } -#+end_src +``` -** Thoughts on Wger -:PROPERTIES: -:CUSTOM_ID: thoughts-on-wger -:END: -I'm still playing around with the app itself, but it seems to be a solid -all-around workout manager, weight log, and food log. +## Thoughts on Wger + +I'm still playing around with the app itself, but it seems to be a +solid all-around workout manager, weight log, and food log. I like that the weight log graph is fluid and updates quickly. You can -also import or export data in CSV format if you'd like to move your data -elsewhere. +also import or export data in CSV format if you'd like to move your +data elsewhere. The workout manager is slightly odd, as it requires you to enter sets and reps for each exercise when you enter it into the plan. Then, when @@ -160,11 +146,8 @@ actually performed, in terms of reps and weight. I haven't tried the food log yet and I likely will not, at least for a while. I have no need for a food log or calorie tracker at the moment. -*** Screenshot Example -:PROPERTIES: -:CUSTOM_ID: screenshot-example -:END: +### Screenshot Example + You can see an example of a dashboard with placeholder data here: -#+caption: wger dashboard -[[https://img.cleberg.net/blog/20230128-wger/wger.png]] + diff --git a/content/blog/2023-02-02-exploring-hare.md b/content/blog/2023-02-02-exploring-hare.md new file mode 100644 index 0000000..42d90aa --- /dev/null +++ b/content/blog/2023-02-02-exploring-hare.md @@ -0,0 +1,171 @@ ++++ +date = 2023-02-02 +title = "Exploring the Hare Programming Language" +description = "A retrospective on my first time using the Hare Programming Language." ++++ + +## A Quick Note + +By no means am I a professional developer, so this post will be rather +short. I won't be going into depth on the specification or anything +that technical. + +Instead, I will simply be talking about how I (a relatively basic +hobbyist programmer) have been playing with Hare and what intrigues me +about the language. + +## Hare + +The [Hare](https://harelang.org) programming language is a +straightforward language that should look familiar if you've ever +programmed with C, Rust, or other languages that aim to build software +at the system-level. + +The Hare homepage states the following: + +> Hare is a systems programming language designed to be simple, stable, +> and robust. Hare uses a static type system, manual memory management, +> and minimal runtime. It is well-suited to writing operating systems, +> system tools, compilers, networking software, and other low-level, +> high performance tasks. + +I have found this all to be true while playing with it for the first +time today. In the next few sections, I'm going to walk through my +installation and first program. + +### Installation + +I'm currently running Alpine Linux on my Thinkpad, so the installation +was quite easy as there is a package for Hare in the `apk` +repositories. + +```sh +doas apk add hare hare-doc +``` + +However, I was able to install Hare from scratch on Fedora Linux a short +while ago, which was also very easy to do. If you need further +instructions and Hare doesn't have a package on your system, take a +look at the [Hare Installation](https://harelang.org/installation/) +page. + +### Creating a Test Project + +In order to play with the language, I created +[hare-test](https://git.sr.ht/~cmc/hare-projects) and will be putting +any of my Hare-related adventures in here. + +> **Update:** I also created a simple Hare program for creating a file +> from user input: +> [files.ha](https://git.sr.ht/~cmc/hare-projects/tree/main/item/files/files.ha) + +Luckily, Hare doesn't require any complex set-up tools or build +environment. Once you have Hare installed, you simply need to create a +file ending with `.ha` and you can run a Hare program. + +I created a file called `rgb.ha` in order to test out the +random number generation and passing parameters between functions. + +```sh +nano rgb.ha +``` + +Within this file, I was able to easily import a few of the [standard +library modules](https://harelang.org/tutorials/stdlib/): +`fmt`, `math::random`, and `datetime`. + +With these modules, I created two functions: + +1. `main`: This function calls the `generate_rgb` + function and then prints out the returned values. +2. `generate_rgb`: This function uses the current Unix epoch + time to generate a pseudo-random value and uses this value to create + three more random values between 0 and 255. These three numbers + represent a color in RGB format. + +> **Note**: Some syntax coloring may look odd, as Zola currently +> doesn't have a syntax highlighting theme for Hare. Instead, I'm +> using the C theme, which may not be exactly accurate when coloring the +> code below. + +```c +use datetime; +use fmt; +use math::random; + +export fn main() void = { + const rgb = generate_rgb(); + fmt::printfln("RGB: ({}, {}, {})", rgb[0], rgb[1], rgb[2])!; +}; + +fn generate_rgb() []u64 = { + // Use the current Unix epoch time as the seed value + let datetime = datetime::epochunix(&datetime::now()); + + // Generate initial pseudo-random value + // You must cast the datetime from int to u64 + let x = random::init(datetime: u64); + + // Generate RGB values between (0, 255) using pseudo-random init value + let r = random::u64n(&x, 255); + let g = random::u64n(&x, 255); + let b = random::u64n(&x, 255); + + // Structure data as array and return + let rgb_array: [3]u64 = [r, g, b]; + return rgb_array; +}; +``` + +### Running a Program + +Once you have a Hare file written and ready to run, you simply need to +run it: + +```sh +hare run file.ha +``` + +You can also compile the program into an executable: + +```sh +hare build -o example file.ha +./example +``` + +### Initial Thoughts + +1. Documentation Improvements Would Help + + While I was able to piece everything together eventually, the + biggest downfall right now in Hare's documentation. For such a new + project, the documentation is in a great spot. However, bare + specifications don't help as much as a brief examples section + would. + + For example, it took me a while to figure out what the + `u64n` function was looking for. I could tell that it + took two parameters and the second was my max value (255), but + couldn't figure out what the first value should be. Eventually, I + inspected the `random.ha` file in the [Hare source + code](https://git.sr.ht/~sircmpwn/hare/tree/master/item/math/random/random.ha) + and found the test suite that helped me discover that it needed an + `init()` value in the form of `&var`. + +2. More Basic Modules + + This is another point that comes from Hare being new and awaiting + more contributions, but there are some basic functions that I would + personally enjoy seeing in Hare, such as one to convert decimal + (base 10) values to hexadecimal (base 16). + + If I'm feeling comfortable with my math, I may work on the list of + functions I want and see if any can make it into the Hare source + code. + +3. Overall Thoughts + + Overall, I actually really enjoy Hare. It's not as tedious to get a + project up and running as Rust, but it's also simpler and more + user-friendly than learning C. I am going to continue playing with + it and see if I can make anything of particular value. diff --git a/blog/2023-05-22-burnout.org b/content/blog/2023-05-22-burnout.md index 8630153..ea58426 100644 --- a/blog/2023-05-22-burnout.org +++ b/content/blog/2023-05-22-burnout.md @@ -1,21 +1,19 @@ -#+title: Burnout -#+date: 2023-05-22 - -** RE: Burnout -:PROPERTIES: -:CUSTOM_ID: re-burnout -:END: -I recently read -[[https://drewdevault.com/2023/05/01/2023-05-01-Burnout.html][Drew -DeVault's post on burnout]] around the same time I was pulling out of a -burnout rut myself earlier this month. Finally, seeing the light at the -end of my burnout tunnel made me want to write my first post back on -this topic. - -** Busy Seasons on Busy Seasons -:PROPERTIES: -:CUSTOM_ID: busy-seasons-on-busy-seasons -:END: ++++ +date = 2023-05-22 +title = "RE: Burnout" +description = "A response to Drew DeVault's burnout post." ++++ + +## RE: Burnout + +I recently read [Drew DeVault's post on +burnout](https://drewdevault.com/2023/05/01/2023-05-01-Burnout.html) +around the same time I was pulling out of a burnout rut myself earlier +this month. Finally, seeing the light at the end of my burnout tunnel +made me want to write my first post back on this topic. + +## Busy Seasons on Busy Seasons + My career deals with busy seasons, generally driven by client demand. This last year, I dealt with a harsh busy season from Aug to Oct 2022 to issue a few SOC reports for the period ending 2022-09-30. Immediately @@ -30,14 +28,12 @@ I have a brief break and need to focus on the 2023-09-30 SOC reports again. While auditing and consulting always involve a busy season, this is the first time I've had one last 9+ months without a break. -While it's been tough, I have a handful of breaks pre-planned throughout -this next cycle and should be able to moderate the level of commitment -required for each client. +While it's been tough, I have a handful of breaks pre-planned +throughout this next cycle and should be able to moderate the level of +commitment required for each client. + +## Refocusing -** Refocusing -:PROPERTIES: -:CUSTOM_ID: refocusing -:END: Outside of work, I finally have time to work on hobbies such as this website, programming, athletics, games, etc. diff --git a/blog/2023-06-08-goaccess-geoip.org b/content/blog/2023-06-08-goaccess-geoip.md index fd49a08..0aef3f7 100644 --- a/blog/2023-06-08-goaccess-geoip.org +++ b/content/blog/2023-06-08-goaccess-geoip.md @@ -1,51 +1,48 @@ -#+title: Inspecting Nginx Logs with GoAccess and MaxMind GeoIP Data -#+date: 2023-06-08 - -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: -[[https://goaccess.io/][GoAccess]] is an open source real-time web log -analyzer and interactive viewer that runs in a terminal in *nix systems ++++ +date = 2023-06-08 +title = "Inspecting Nginx Logs with GoAccess and MaxMind GeoIP Data" +description = "Learn how to use GoAccess and MaxMind to evaluate visitors to your web server." ++++ + +## Overview + +[GoAccess](https://goaccess.io/) is an open source real-time web log +analyzer and interactive viewer that runs in a terminal in \*nix systems or through your browser. -** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: -To start, you'll need to install GoAccess for your OS. Here's an example -for Debian-based distros: +## Installation + +To start, you'll need to install GoAccess for your OS. Here's an +example for Debian-based distros: -#+begin_src sh +```sh sudo apt install goaccess -#+end_src +``` Next, find any number of the MaxMind GeoIP database files on GitHub or another file hosting website. We're going to use P3TERX's version in this example: -#+begin_src sh +```sh wget https://github.com/P3TERX/GeoLite.mmdb/raw/download/GeoLite2-City.mmdb -#+end_src +``` Be sure to save this file in an easy to remember location! -** Usage -:PROPERTIES: -:CUSTOM_ID: usage -:END: +## Usage + In order to utilize the full capabilities of GoAccess and MMDB, start with the command template below and customize as necessary. This will export an HTML view of the GoAccess dashboard, showing all relevant information related to that site's access log. You can also omit the -=-o output.html= parameter if you prefer to view the data within the CLI -instead of creating an HTML file. +`-o output.html` parameter if you prefer to view the data +within the CLI instead of creating an HTML file. With the addition of the GeoIP Database parameter, section -=16 - Geo Location= will be added with the various countries that are -associated with the collected IP addresses. +`16 - Geo Location` will be added with the various countries +that are associated with the collected IP addresses. -#+begin_src sh +```sh zcat /var/log/nginx/example.access.log.*.gz | goaccess \ --geoip-database=/home/user/GeoLite2-City.mmdb \ --date-format=%d/%b/%Y \ @@ -53,22 +50,20 @@ zcat /var/log/nginx/example.access.log.*.gz | goaccess \ --log-format=COMBINED \ -o output.html \ /var/log/nginx/example.access.log - -#+end_src +``` + +### Example Output -*** Example Output -:PROPERTIES: -:CUSTOM_ID: example-output -:END: See below for an example of the HTML output: -#+caption: GoAccess HTML -[[https://img.cleberg.net/blog/20230608-goaccess/goaccess-dashboard.png]] + You can also see the GeoIP card created by the integration of the MaxMind database information. -#+caption: GoAccess GeoIP -[[https://img.cleberg.net/blog/20230608-goaccess/goaccess-geoip.png]] + That's all there is to it! Informational data is provided in an organized fashion with minimal effort. diff --git a/blog/2023-06-08-self-hosting-baikal-server.org b/content/blog/2023-06-08-self-hosting-baikal-server.md index 14a616b..ceb0e89 100644 --- a/blog/2023-06-08-self-hosting-baikal-server.org +++ b/content/blog/2023-06-08-self-hosting-baikal-server.md @@ -1,34 +1,34 @@ -#+title: Self-Hosting Baïkal Server -#+date: 2023-06-08 - -** What is Baïkal? -:PROPERTIES: -:CUSTOM_ID: what-is-baïkal -:END: -[[https://sabre.io/baikal/][Baïkal]] is a lightweight CalDAV + CardDAV ++++ +date = 2023-06-08 +title = "Self-Hosting Baïkal Server (CalDAV & CardDAV)" +description = "A guide to self-hosting the Baïkal application on your own server." ++++ + +## What is Baïkal? + +[Baïkal](https://sabre.io/baikal/) is a lightweight CalDAV + CardDAV server that you can self-host on your own machine. While I have tried (& failed) to get this CalDAV + CardDAV server running before, it was quite easy this time. Not really sure what I did differently this time, but I'm documenting my process here to ensure I don't forget. -** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: -First, create a folder on your server and open a =docker-compose.yml= -file for editing: +## Installation -#+begin_src sh +First, create a folder on your server and open a +`docker-compose.yml` file for editing: + +```sh mkdir baikal && cd baikal nano docker-compose.yml -#+end_src +``` Within this file, you'll need to paste the information below. You can -customize the =ports= section to use any port on your server to pass -through to port 80 in the container. You can also edit the =volumes= -section to use docker volumes instead of local folders. +customize the `ports` section to use any port on your server +to pass through to port 80 in the container. You can also edit the +`volumes` section to use docker volumes instead of local +folders. -#+begin_src conf +```conf version: "2" services: baikal: @@ -39,50 +39,45 @@ services: volumes: - ./config:/var/www/baikal/config - ./data:/var/www/baikal/Specific -#+end_src +``` Once finished with editing, save and close the file. Then, launch the docker container: -#+begin_src sh +```sh sudo docker-compose up -d -#+end_src +``` + +## Intial Setup -** Intial Setup -:PROPERTIES: -:CUSTOM_ID: intial-setup -:END: As long as no issues came up when starting the container, you should be -able to visit the server's set-up page at =http://<server_ip>:<port>=. -The application will ask you to create an administrator account and -choose the database type for your storage. Personally, I opted to use -SQLite. +able to visit the server's set-up page at +`http://<server_ip>:<port>`. The application will ask you to +create an administrator account and choose the database type for your +storage. Personally, I opted to use SQLite. Make sure the administrator credentials are adequate to protect against common attacks. -** Creating Users -:PROPERTIES: -:CUSTOM_ID: creating-users -:END: -Once you've set up the application, you will be greeted by the Dashboard -page, which will show the version of the app, status of the +## Creating Users + +Once you've set up the application, you will be greeted by the +Dashboard page, which will show the version of the app, status of the admin/CalDAV/CardDAV services, and the number of users, calendars, events, address books, and contacts. -#+caption: Baïkal Dashboard -[[https://img.cleberg.net/blog/20230608-baikal/baikal-dashboard.png]] + -To create a new user, navigate to the =Users and resources= page. This -process is as simple as entering a username, password, and email. +To create a new user, navigate to the `Users and resources` +page. This process is as simple as entering a username, password, and +email. Once a user has been created, you can create any number of calendars and address books for user, as well as inspect their information. -** Setting Up a Public URL -:PROPERTIES: -:CUSTOM_ID: setting-up-a-public-url -:END: +## Setting Up a Public URL + Once your application is working locally, you can open access remotely via a URL by using a reverse-proxy like Nginx. @@ -92,15 +87,15 @@ point a domain name to the server hosting Baïkal. Start by navigating to your web server's configuration directory and create a new file for this application. -#+begin_src sh +```sh cd /etc/nginx/sites-available/ nano dav -#+end_src +``` Within this file, paste in the configuration from below and change -=dav.example.com= to match the URL you'll be using. +`dav.example.com` to match the URL you'll be using. -#+begin_src conf +```conf server { if ($host ~ ^[^.]+\.example\.com$) { return 301 https://$host$request_uri; @@ -130,37 +125,35 @@ server { include /etc/letsencrypt/options-ssl-nginx.conf; ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; } -#+end_src +``` For Nginx on Ubuntu, you'll need to symlink the configuration file to -the =sites-enabled= directory and then restart Nginx. +the `sites-enabled` directory and then restart Nginx. -#+begin_src sh +```sh sudo ln -s /etc/nginx/sites-available/dav /etc/nginx/sites-enabled/dav sudo systemctl restart nginx.service -#+end_src +``` At this point, the Baïkal server should be available over the internet at the URL configured above! -** Configuring Clients -:PROPERTIES: -:CUSTOM_ID: configuring-clients -:END: +## Configuring Clients + Lastly, configuring clients and applications is essential to making sure the DAV server is being fully utilized. -You can also use the =Users and resources= page to inspect a user's -personal link to their calendars and address books by clicking the info -(i) button. It will show a URI like -=/dav.php/calendars/your-user/default/=. +You can also use the `Users and resources` page to inspect a +user's personal link to their calendars and address books by clicking +the info (i) button. It will show a URI like +`/dav.php/calendars/your-user/default/`. However, I found that the following URL works for most applications: -=/dav.php/principals/your-user/=. +`/dav.php/principals/your-user/`. -I used the =principals= URL above for Thunderbird (calendar, tasks, and -contacts), as well as iOS (calendar, tasks, and contacts) and everything -works flawlessly so far. +I used the `principals` URL above for Thunderbird (calendar, +tasks, and contacts), as well as iOS (calendar, tasks, and contacts) and +everything works flawlessly so far. Syncing is quick between the server and clients, and I haven't seen any disruptions in the service or data integrity. diff --git a/content/blog/2023-06-18-unifi-ip-blocklist.md b/content/blog/2023-06-18-unifi-ip-blocklist.md new file mode 100644 index 0000000..7992852 --- /dev/null +++ b/content/blog/2023-06-18-unifi-ip-blocklist.md @@ -0,0 +1,87 @@ ++++ +date = 2023-06-18 +title = "Block IP Addresses and Subnets with Unifi Network Firewall" +description = "Learn how to use the Unifi Network Firewall to block IP addresses and subnets." ++++ + +## Identifying Abusive IPs + +If you're like me and use Unifi network equipment at the edge of the +network you manage, you may know that Unifi is only somewhat decent at +identifying and blocking IPs that represent abusive or threat actors. + +While Unifi has a [threat +management](https://help.ui.com/hc/en-us/articles/360006893234-UniFi-Gateway-Threat-Management) +tool inside their Network application, it can be lacking in +functionality and identification. For example, I have my UDM Pro set to +identify and block almost all categories of threats available within the +Unifi settings. However, I regularly identify abusive actors on my web +server via the server logs. + +In addition, I have identified IP addresses and subnets directly within +Unifi's logs that the UDM did not block for whatever reason. + +This guide is meant to be another step in the process to manually block +abusive IP addresses or subnets that you have identified but are not +being automatically blocked yet. + +## Create an IP Group Profile + +To start, login to the Unifi machine's web GUI and navigate to the +Network app \> Settings \> Profiles. + +Within this page, choose the `IP Groups` tab and click +`Create New`. + + + +Each IP Group profile can be used as one of three options: + +1. Port Group +2. IPv4 Address/Subnet +3. IPv6 Address/Subnet + +In this example, I'm creating an IPv4 Address/Subnet group and adding a +few different IP addresses and a subnet. Once you've added all IP +addresses and subnets, click the `Apply` button that should +appear at the bottom. + + + +At this point, the IPv4 Address/Subnet has been created but not yet +used. + +## Drop IP Group Profile via the Unifi Firewall + +To instruct the Unifi machine to block the profile we just created, we +need to navigate to the Network app \> Settings \> Firewall & Security. + +Within this screen, find the Firewall Rules table and click +`Create Entry`. This entry should contain the following +settings: + +- Type: `Internet In` +- Description: `<Your Custom Rule>` +- Rule Applied: `Before Predefined Rules` +- Action: `Drop` +- Source Type: `Port/IP Group` +- IPv4 Address Group: + `<Name of the Group Profile You Created Above>` + +Customize the remaining configurations to your liking, and then save and +enable the firewall rule. + + + +Once enabled, the Unifi machine will be able to drop all incoming +connections from the defined IP addresses and subnets within the created +profile. + +> As a personal aside to this topic, I'm looking for a convenient way +> to update the firewall rules or profiles remotely (within the LAN) +> from the web server to accelerate this process. If you have an idea on +> how to automatically update Unifi IP groups or firewall rules, let me +> know! diff --git a/content/blog/2023-06-20-audit-review-template.md b/content/blog/2023-06-20-audit-review-template.md new file mode 100644 index 0000000..6236fe6 --- /dev/null +++ b/content/blog/2023-06-20-audit-review-template.md @@ -0,0 +1,80 @@ ++++ +date = 2023-06-20 +title = "Audit Testing Review Template" +description = "A handy reference template for audit reviews." ++++ + +## Overview + +This post is a *very* brief overview on the basic process to review +audit test results, focusing on work done as part of a financial +statement audit (FSA) or service organization controls (SOC) report. + +While there are numerous different things to review and look for - all +varying wildly depending on the report, client, and tester - this list +serves as a solid base foundation for a reviewer. + +I have used this throughout my career as a starting point to my reviews, +and it has worked wonders for creating a consistent and objective +template to my reviews. The goal is to keep this base high-level enough +to be used on a wide variety of engagements, while still ensuring that +all key areas are covered. + +## Review Template + +1. [ ] Check all documents for spelling and grammar. +2. [ ] Ensure all acronyms are fully explained upon first use. +3. [ ] For all people referenced, use their full names and job titles + upon first use. +4. [ ] All supporting documents must cross-reference to the lead sheet + and vice-versa. +5. [ ] Verify that the control has been adequately tested: + - [ ] **Test of Design**: Did the tester obtain information + regarding how the control should perform normally and abnormally + (e.g., emergency scenarios)? + - [ ] **Test of Operating Effectiveness**: Did the tester inquire, + observe, inspect, or re-perform sufficient evidence to support + their conclusion over the control? Inquiry alone is not + adequate! +6. [ ] For any information used in the control, whether by the control + operator or by the tester, did the tester appropriately document the + source (system or person), extraction method, parameters, and + completeness and accuracy (C&A)? + - [ ] For any reports, queries, etc. used in the extraction, did + the tester include a copy and notate C&A considerations? +7. [ ] Did the tester document the specific criteria that the control + is being tested against? +8. [ ] Did the tester notate in the supporting documents where each + criterion was satisfied? +9. [ ] If testing specific policies or procedures, are the documents + adequate? + - [ ] e.g., a test to validate that a review of policy XYZ occurs + periodically should also evaluate the sufficiency of the policy + itself, if meant to cover the risk that such a policy does not + exist and is not reviewed. +10. [ ] Does the test cover the appropriate period under review? + - [ ] If the test is meant to cover only a portion of the audit + period, do other controls exist to mitigate the risks that exist + for the remainder of the period? +11. [ ] For any computer-aided audit tools (CAATs) or other automation + techniques used in the test, is the use of such tools explained and + appropriately documented? +12. [ ] If prior-period documentation exists, are there any missing + pieces of evidence that would further enhance the quality of the + test? +13. [ ] Was any information discovered during the walkthrough or inquiry + phase that was not incorporated into the test? +14. [ ] Are there new rules or expectations from your company's + internal guidance or your regulatory bodies that would affect the + audit approach for this control? +15. [ ] Was an exception, finding, or deficiency identified as a result + of this test? + - [ ] Was the control deficient in design, operation, or both? + - [ ] What was the root cause of the finding? + - [ ] Does the finding indicate other findings or potential fraud? + - [ ] What's the severity and scope of the finding? + - [ ] Do other controls exist as a form of compensation against + the finding's severity, and do they mitigate the risk within + the control objective? + - [ ] Does the finding exist at the end of the period, or was it + resolved within the audit period? diff --git a/blog/2023-06-23-byobu.org b/content/blog/2023-06-23-byobu.md index 389df63..1097205 100644 --- a/blog/2023-06-23-byobu.org +++ b/content/blog/2023-06-23-byobu.md @@ -1,40 +1,36 @@ -#+title: Byobu -#+date: 2023-06-23 ++++ +date = 2023-06-23 +title = "Byobu" +description = "Learning about the Byobu application for terminals." ++++ -** Byobu -:PROPERTIES: -:CUSTOM_ID: byobu -:END: -[[https://www.byobu.org][byobu]] is a command-line tool that allows you -to use numerous screens within a single terminal emulator instance. More -specifically, it's a text based window manager, using either =screen= or -=tmux=. +## Byobu + +[byobu](https://www.byobu.org) is a command-line tool that allows you to +use numerous screens within a single terminal emulator instance. More +specifically, it's a text based window manager, using either +`screen` or `tmux`. This post is mostly just a self-reference as I explore byobu, so I may come back later and update this post with more content. -*** Screenshot -:PROPERTIES: -:CUSTOM_ID: screenshot -:END: +### Screenshot + Take a look below at my current multi-window set-up in byobu while I write this blog post: -#+caption: byobu -[[https://img.cleberg.net/blog/20230623-byobu/byobu.png]] + + +## Keybindings -** Keybindings -:PROPERTIES: -:CUSTOM_ID: keybindings -:END: You can open the help menu with either of the following commands; they will both open the same manpage: -#+begin_src sh +```sh byobu --help # or man byobu -#+end_src +``` While the manpage contains a ton of information about the functionality of byobu (such as status notifications, sessions, and windows), the @@ -42,7 +38,7 @@ first location to explore should be the keybindings section. The keybindings are configured as follows: -#+begin_src txt +```txt byobu keybindings can be user defined in /usr/share/byobu/keybindings/ (or within .screenrc if byobu-export was used). The common key bindings are: @@ -70,4 +66,4 @@ Ctrl-a R - Reload profile Ctrl-a ! - Toggle key bindings on and off Ctrl-a k - Kill the current window Ctrl-a ~ - Save the current window's scrollback buffer -#+end_src +``` diff --git a/blog/2023-06-23-self-hosting-convos-irc.org b/content/blog/2023-06-23-self-hosting-convos-irc.md index b86d01b..e29d7a6 100644 --- a/blog/2023-06-23-self-hosting-convos-irc.org +++ b/content/blog/2023-06-23-self-hosting-convos-irc.md @@ -1,43 +1,43 @@ -#+title: Self-Hosting Convos: IRC Web Client -#+date: 2023-06-23 - -** Convos -:PROPERTIES: -:CUSTOM_ID: convos -:END: -[[https://convos.chat/][Convos]] is an always-online web client for IRC. ++++ +date = 2023-06-23 +title = "Self-Hosting Convos IRC Web Client" +description = "A guide to self-hosting the Convos application on your own server." ++++ + +## Convos + +[Convos](https://convos.chat/) is an always-online web client for IRC. It has a few features that made it attractive to me as a self-hosted option: -- Extremely simple Docker Compose installation method. -- Runs in the background and monitors chats even while you're not logged - in. -- Neatly organized sidebar for conversation and client settings. -- Ability to connect to different hosts and create profiles for hosts. -- By default, registration is closed to the public. You can enable - public registration on the Settings page or generate invitation links - on the Users page. -- Customization of the client theme, organization name and URL, admin - email, and video service. - -** Docker Installation -:PROPERTIES: -:CUSTOM_ID: docker-installation -:END: -To install Convos, simply create a directory and a =docker-compose.yml= -file: - -#+begin_src sh +- Extremely simple Docker Compose installation method. +- Runs in the background and monitors chats even while you're not + logged in. +- Neatly organized sidebar for conversation and client settings. +- Ability to connect to different hosts and create profiles for hosts. +- By default, registration is closed to the public. You can enable + public registration on the Settings page or generate invitation + links on the Users page. +- Customization of the client theme, organization name and URL, admin + email, and video service. + +## Docker Installation + +To install Convos, simply create a directory and a +`docker-compose.yml` file: + +```sh mkdir ~/convos && cd ~/convos nano docker-compose.yml -#+end_src +``` -With the =docker-compose.yml= file open, paste the configuration below -into the file. You can customize the host port to be something unique, -such as =21897:3000=. You can also change the =data= folder to be a -docker volume instead, if you prefer. +With the `docker-compose.yml` file open, paste the +configuration below into the file. You can customize the host port to be +something unique, such as `21897:3000`. You can also change +the `data` folder to be a docker volume instead, if you +prefer. -#+begin_src config +```config version: '3' services: @@ -50,34 +50,33 @@ services: environment: - CONVOS_REVERSE_PROXY=1 restart: always -#+end_src +``` -Save the =docker-compose.yml= file and bring the container up: +Save the `docker-compose.yml` file and bring the container +up: -#+begin_src sh +```sh sudo docker-compose up -d -#+end_src +``` + +At this point, Convos is available at `<server_ip>:3000` but +not available to the public. -At this point, Convos is available at =<server_ip>:3000= but not -available to the public. +## Nginx Reverse Proxy -** Nginx Reverse Proxy -:PROPERTIES: -:CUSTOM_ID: nginx-reverse-proxy -:END: If you're using Nginx, you can create a configuration file for the convos application. Start by opening the file: -#+begin_src sh +```sh nano /etc/nginx/sites-available/convos -#+end_src +``` Within the nginx configuration file, paste the following content and be -sure to update =convos.example.com= to match your domain and -=127.0.0.1:3000= to match the port you opened in the -=docker-compose.yml= file. +sure to update `convos.example.com` to match your domain and +`127.0.0.1:3000` to match the port you opened in the +`docker-compose.yml` file. -#+begin_src config +```config # Host and port where convos is running upstream convos_upstream { server 127.0.0.1:3000; } @@ -115,59 +114,59 @@ server { include /etc/letsencrypt/options-ssl-nginx.conf; ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; } -#+end_src +``` -Once the file is saved, link it to the =sites-enabled= directory and -restart Nginx. +Once the file is saved, link it to the `sites-enabled` +directory and restart Nginx. -#+begin_src sh +```sh sudo ln -s /etc/nginx/sites-available/convos /etc/nginx/sites-enabled/convos sudo systemctl restart nginx.service -#+end_src +``` + +## Screenshots -** Screenshots -:PROPERTIES: -:CUSTOM_ID: screenshots -:END: See the screenshots below for an example of the Convos homepage and an excerpt of the chat screen. There are numerous themes to choose from; the theme shown in the images below is Dracula. +```{=org} #+caption: Convos Home -[[https://img.cleberg.net/blog/20230623-convos/convos_home.png%20%22Convos%20Home%22]] +``` +<https://img.cleberg.net/blog/20230623-convos/convos_home.png%20%22Convos%20Home%22> +```{=org} #+caption: Convos Chat -[[https://img.cleberg.net/blog/20230623-convos/convos_chat.png%20%22Convos%20Chat%22]] +``` +<https://img.cleberg.net/blog/20230623-convos/convos_chat.png%20%22Convos%20Chat%22> + +## Registering a Nickname -** Registering a Nickname -:PROPERTIES: -:CUSTOM_ID: registering-a-nickname -:END: Hop into the server channel so that you can message NickServ. In the case of Convos, the default sever is libera.chat. Simply click the -=libera= conversation at the top of the sidebar to open it. Once the -chat is open, you can claim a nickname by typing: +`libera` conversation at the top of the sidebar to open it. +Once the chat is open, you can claim a nickname by typing: -#+begin_src txt +```txt /nick <nick> -#+end_src +``` -If the nickname is available, and you'd like to register the nickname to -yourself, you'll need to type another command: +If the nickname is available, and you'd like to register the nickname +to yourself, you'll need to type another command: -#+begin_src txt +```txt /msg NickServ REGISTER <password> <email> -#+end_src +``` On libera.chat, the server will send a confirmation email with a command that you must message in IRC to verify registration of the nickname: -#+begin_src txt +```txt /msg NickServ VERIFY REGISTER <nick> <verification_code> -#+end_src +``` Once entered, the server should confirm registration of the nickname to the supplied email with the password specified. diff --git a/content/blog/2023-06-28-backblaze-b2.md b/content/blog/2023-06-28-backblaze-b2.md new file mode 100644 index 0000000..5793846 --- /dev/null +++ b/content/blog/2023-06-28-backblaze-b2.md @@ -0,0 +1,188 @@ ++++ +date = 2023-06-28 +title = "Getting Started with Backblaze B2 Cloud Storage" +description = "An introduction to the free ttier of Backblaze B2 Cloud Storage." ++++ + +## Overview + +Backblaze [B2 Cloud +Storage](https://www.backblaze.com/b2/cloud-storage.html) is an +inexpensive and reliable on-demand cloud storage and backup solution. + +The service starts at \$5/TB/month (\$0.005/GB/month) with a download +rate of \$0.01/GB/month. + +However, there are free tiers: + +- The first 10 GB of storage is free. +- The first 1 GB of data downloaded each day is free. +- Class A transactions are free. +- The first 2500 Class B transactions each day are free. +- The first 2500 Class C transactions each day are free. + +You can see which API calls fall into categories A, B, or C here: +[Pricing Organized by API +Calls](https://www.backblaze.com/b2/b2-transactions-price.html). + +For someone like me, who wants an offsite backup of their server's +`/home/` directory and various other server configs that fall +under 10 GB total, Backblaze is a great solution from a financial +perspective. + +## Create An Account + +To start with Backblaze, you'll need to [create a free +account](https://www.backblaze.com/b2/sign-up.html) - no payment method +is required to sign up. + +Once you have an account, you can test out the service with their web +GUI, their mobile app, or their CLI tool. I'm going to use the CLI tool +below to test a file upload and then sync an entire directory to my +Backblaze bucket. + +## Create a Bucket + +Before you can start uploading, you need to create a bucket. If you're +familiar with other object storage services, this will feel familiar. If +not, it's pretty simple to create one. + +As their webpage says: + +> A bucket is a container that holds files that are uploaded into B2 +> Cloud Storage. The bucket name must be globally unique and must have a +> minimum of 6 characters. A limit of 100 buckets may be created per +> account. An unlimited number of files may be uploaded into a bucket. + +Once you click the `Create a Bucket` button on their webpage +or mobile app, you need to provide the following: + +- Bucket Unique Name +- Files in Bucket are: `Private` or `Public` +- Default Encryption: `Disable` or `Enable` +- Object Lock: `Disable` or `Enable` + +For my bucket, I created a private bucket with encryption enabled and +object lock disabled. + +Once your bucket is created, you can test the upload/download feature on +their web GUI or mobile app! At this point, you have a fully functional +bucket and account. + +## Linux CLI Tool + +### Installation + +To install the `b2` CLI tool, you'll need to download it +from the [CLI +Tools](https://www.backblaze.com/docs/cloud-storage-command-line-tools) +page. I recommend copying the URL from the link that says +`Linux` and using wget to download it, as shown below. + +Once downloaded, make the file executable and move it to a location on +your `$PATH`, so that you can execute that command from +anywhere on the machine. + +```sh +wget <b2_cli_url> +chmod +x b2_linux +mv b2_linux /usr/bin/b2 +``` + +### Log In + +The first step after installation is to log in. To do this, execute the +following command and provide your `<applicationKeyId>` and +`<applicationKey>`. + +If you don't want to provide these values in the command itself, you +can simply execute the base command and it will request them in an +interactive prompt. + +```sh +# if you want to provide the keys directly: +b2 authorize-account [<applicationKeyId>] [<applicationKey>] + +# or, if you don't want your keys in your shell history: +b2 authorize-account +``` + +### Upload a Test File + +In order to test the functionality of the CLI tool, I'll start by +uploading a single test file to the bucket I created above. We can do +this with the `upload_file` function. + +The command is issued as follows: + +```sh +b2 upload_file <bucket_name> <local_file> <remote_file> +``` + +In my situation, I executed the following command with my username. + +```sh +b2 upload_file my_unique_bucket /home/<user>/test.md test.md +``` + +To confirm that the file was uploaded successfully, list the files in +your bucket: + +```sh +b2 ls <bucket_name> +``` + +```txt +test.md +``` + +### Sync a Directory + +If you have numerous files, you can use the `sync` function +to perform functionality similar to `rsync`, where you can +check what's in your bucket and sync anything that is new or modified. + +The command is issued as follows: + +```sh +b2 sync <source file location> <B2 bucket destination> +``` + +In my case, I can sync my user's entire home directory to my bucket +without specifying any of the files directly: + +```sh +b2 sync /home/<user>/ "b2://<bucketName>/home/<user>" +``` + +## Caveats + +### Timing of Updates to the Web GUI + +When performing actions over a bucket, there is a slight delay in the +web GUI when inspecting a bucket or its file. Note that simple actions +such as uploading or deleting files may have a delay of a few minutes up +to 24 hours. In my experience (\<10 GB and \~20,000 files), any actions +took only a few minutes to update across clients. + +### Symlinks + +Note that symlinks are resolved by b2, so if you have a link from +`/home/<user>/nas-storage` that symlinks out to a +`/mnt/nas-storage` folder that has 10TB of data, +`b2` will resolve that link and start uploading all 10TB of +data linked within the folder. + +If you're not sure if you have any symlinks, a symlink will look like +this (note the `->` symbol): + +```sh +> ls -lha +lrwxrwxrwx 1 root root 20 Jun 28 13:32 nas -> /mnt/nas-storage/ +``` + +You can recursively find symlink in a path with the following command: + +```sh +ls -lR /path/to/search | grep '^l' +``` diff --git a/blog/2023-06-30-self-hosting-voyager-lemmy-client.org b/content/blog/2023-06-30-self-hosting-voyager-lemmy-client.md index 2530e07..f27ab65 100644 --- a/blog/2023-06-30-self-hosting-voyager-lemmy-client.org +++ b/content/blog/2023-06-30-self-hosting-voyager-lemmy-client.md @@ -1,57 +1,55 @@ -#+title: Self-Hosting Voyager: A Lemmy Web Client -#+date: 2023-06-30 ++++ +date = 2023-06-30 +title = "Self-Hosting Voyager - A Lemmy Web Client" +description = "A guide to self-hosting the Voyager application on your own server." ++++ -** Installation Guide -:PROPERTIES: -:CUSTOM_ID: installation-guide -:END: -[[https://github.com/aeharding/voyager][Voyager]] is a mobile-first -Lemmy web client, based on iOS design standards. It follows very closely -to Apollo's design. +## Installation Guide + +[Voyager](https://github.com/aeharding/voyager) is a mobile-first Lemmy +web client, based on iOS design standards. It follows very closely to +Apollo's design. This post is a guide showing how I was able to build and launch my own instance of Voyager via Docker Compose. -*** Clone the Repository -:PROPERTIES: -:CUSTOM_ID: clone-the-repository -:END: +### Clone the Repository + Start by cloning the repository and entering it: -#+begin_src sh +```sh git clone https://github.com/aeharding/voyager cd voyager -#+end_src +``` + +### Build the Image -*** Build the Image -:PROPERTIES: -:CUSTOM_ID: build-the-image -:END: With this repository, you can build the image yourself without any further configuration. When complete, it'll give you the image ID for you to run. -#+begin_src sh +```sh sudo docker build . # Successfully built 5f00723cb5be -#+end_src +``` With the image ID above, you can run the container and pass the -requested port =5314= through or use a custom port, if you wish. +requested port `5314` through or use a custom port, if you +wish. -You can also set the =CUSTOM_LEMMY_SERVERS= environment variable if you -want to add to the default suggested login servers. This must be set -with a comma separated list of suggested servers. The first instance in -the list will be the default view for logged-out users. +You can also set the `CUSTOM_LEMMY_SERVERS` environment +variable if you want to add to the default suggested login servers. This +must be set with a comma separated list of suggested servers. The first +instance in the list will be the default view for logged-out users. -I will be using a =docker-compose.yml= file to run this container, -instead of a =docker run= command. +I will be using a `docker-compose.yml` file to run this +container, instead of a `docker run` command. -#+begin_src sh +```sh nano docker-compose.yml -#+end_src +``` -#+begin_src conf +```conf version: "2" services: voyager: @@ -61,32 +59,30 @@ services: - "<custom_port>:5314" environment: - CUSTOM_LEMMY_SERVERS=lemmy.dbzer0.com,lemmy.world,lemmy.ml,beehaw.org -#+end_src +``` -#+begin_src sh +```sh sudo docker-compose up -d -#+end_src +``` The web app will now be available at the following address: -=<machine_ip>:<custom_port>=. If you are running it on your local -device, try =localhost:<custom_port>=. +`<machine_ip>:<custom_port>`. If you are running it on your +local device, try `localhost:<custom_port>`. + +### Reverse Proxy -*** Reverse Proxy -:PROPERTIES: -:CUSTOM_ID: reverse-proxy -:END: -If you want to visit this app via an external URL or domain name, you'll -need to set up a reverse proxy. The example below uses Nginx as a -reverse proxy. +If you want to visit this app via an external URL or domain name, +you'll need to set up a reverse proxy. The example below uses Nginx as +a reverse proxy. Simply create the configuration file, paste the contents below, save the file, symlink the file, and restart Nginx. -#+begin_src sh +```sh sudo nano /etc/nginx/sites-available/voyager -#+end_src +``` -#+begin_src conf +```conf server { if ($host ~ ^[^.]+\.example\.com$) { return 301 https://$host$request_uri; @@ -116,14 +112,15 @@ server { include /etc/letsencrypt/options-ssl-nginx.conf; ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; } -#+end_src +``` -#+begin_src sh +```sh sudo ln sudo ln -s /etc/nginx/sites-available/voyager /etc/nginx/sites-enabled/voyager sudo systemctl restart nginx.service -#+end_src +``` -The site will now be available at the =server_name= you specified above! +The site will now be available at the `server_name` you +specified above! You can visit my instance at -[[https://voyager.cleberg.net][voyager.cleberg.net]] for an example. +[voyager.cleberg.net](https://voyager.cleberg.net) for an example. diff --git a/blog/2023-07-12-mullvad-wireguard-lan.org b/content/blog/2023-07-12-mullvad-wireguard-lan.md index 1838862..a8e2b7f 100644 --- a/blog/2023-07-12-mullvad-wireguard-lan.org +++ b/content/blog/2023-07-12-mullvad-wireguard-lan.md @@ -1,32 +1,30 @@ -#+title: Enabling LAN Access in Mullvad Wireguard Conf Files -#+date: 2023-07-12 - -** Download Configuration Files from Mullvad -:PROPERTIES: -:CUSTOM_ID: download-configuration-files-from-mullvad -:END: -To begin, you'll need -[[https://mullvad.net/account/wireguard-config][Wireguard configuration -files from Mullvad]]. You can choose any of the options as you download -them. For example, I enabled the kill switch, selected all countries, -and selected a few content filters. ++++ +date = 2023-07-12 +title = "Enable LAN Access in Mullvad Wireguard Conf Files" +description = "Learn how to enable LAN access manually in Mullvad configuration files." ++++ + +## Download Configuration Files from Mullvad + +To begin, you'll need [Wireguard configuration files from +Mullvad](https://mullvad.net/account/wireguard-config). You can choose +any of the options as you download them. For example, I enabled the kill +switch, selected all countries, and selected a few content filters. Once downloaded, unzip the files and move them to the Wireguard folder on your system. -#+begin_src sh +```sh cd ~/Downloads unzip mullvad_wireguard_linux_all_all.zip doas mv *.conf /etc/wireguard/ -#+end_src +``` + +### Configuration File Layout -*** Configuration File Layout -:PROPERTIES: -:CUSTOM_ID: configuration-file-layout -:END: The default configuration files will look something like this: -#+begin_src conf +```conf [Interface] # Device: <redacted> PrivateKey = <redacted> @@ -39,50 +37,45 @@ PreDown = iptables -D OUTPUT ! -o %i -m mark ! --mark $(wg show %i fwmark) -m ad PublicKey = <redacted> AllowedIPs = <redacted> Endpoint = <redacted> -#+end_src +``` -#+begin_quote -Note: If you didn't select the kill switch option, you won't see the -=PostUp= and =PreDown= lines. In this case, you'll need to modify the -script below to simply append those lines to the =[Interface]= block. +> Note: If you didn't select the kill switch option, you won't see the +> `PostUp` and `PreDown` lines. In this case, +> you'll need to modify the script below to simply append those lines +> to the `[Interface]` block. -#+end_quote +## Editing the Configuration Files -** Editing the Configuration Files -:PROPERTIES: -:CUSTOM_ID: editing-the-configuration-files -:END: Once you have the files, you'll need to edit them and replace the -=PostUp= and =PreDown= lines to enable LAN access. +`PostUp` and `PreDown` lines to enable LAN access. I recommend that you do this process as root, since you'll need to be -able to access files in =/etc/wireguard=, which are generally owned by -root. You can also try using =sudo= or =doas=, but I didn't test that -scenario so you may need to adjust, as necessary. +able to access files in `/etc/wireguard`, which are generally +owned by root. You can also try using `sudo` or +`doas`, but I didn't test that scenario so you may need to +adjust, as necessary. -#+begin_src sh +```sh su -#+end_src +``` Create the Python file that we'll be using to update the Wireguard configuration files. -#+begin_src sh +```sh nano replace.py -#+end_src +``` Within the Python file, copy and paste the logic below. This script will open a directory, loop through every configuration file within the -directory, and replace the =PostUp= and =PreDown= lines with the new -LAN-enabled iptables commands. - -#+begin_quote -Note: If your LAN is on a subnet other than =192.168.1.0/24=, you'll -need to update the Python script below appropriately. +directory, and replace the `PostUp` and `PreDown` +lines with the new LAN-enabled iptables commands. -#+end_quote +> Note: If your LAN is on a subnet other than +> `192.168.1.0/24`, you'll need to update the Python script +> below appropriately. -#+begin_src python +```python import os import fileinput @@ -101,25 +94,25 @@ for file in os.listdir(dir): print(line, end="") print("--- done ---") -#+end_src +``` Once you're done, save and close the file. You can now run the Python script and watch as each file is updated. -#+begin_src sh +```sh python3 replace.py -#+end_src +``` -To confirm it worked, you can =cat= one of the configuration files to -inspect the new logic and connect to one to test it out. +To confirm it worked, you can `cat` one of the configuration +files to inspect the new logic and connect to one to test it out. -#+begin_src sh +```sh cat /etc/wireguard/us-chi-wg-001.conf -#+end_src +``` The configuration files should now look like this: -#+begin_src conf +```conf [Interface] # Device: <redacted> PrivateKey = <redacted> @@ -132,20 +125,20 @@ PreDown = iptables -D OUTPUT ! -o %i -m mark ! --mark $(wg show %i fwmark) -m ad PublicKey = <redacted> AllowedIPs = <redacted> Endpoint = <redacted> -#+end_src +``` -If you connect to a Wireguard interface, such as =us-chi-wg-001=, you -can test your SSH functionality and see that it works even while on the -VPN. +If you connect to a Wireguard interface, such as +`us-chi-wg-001`, you can test your SSH functionality and see +that it works even while on the VPN. -#+begin_src sh +```sh wg-quick up us-chi-wg-001 ssh user@lan-host -#+end_src +``` To confirm your VPN connection, you can curl Mullvad's connection API: -#+begin_src sh +```sh curl https://am.i.mullvad.net/connected # You are connected to Mullvad (server us-chi-wg-001). Your IP address is <redacted> -#+end_src +``` diff --git a/blog/2023-07-19-plex-transcoder-errors.org b/content/blog/2023-07-19-plex-transcoder-errors.md index 554e3fe..0a5e616 100644 --- a/blog/2023-07-19-plex-transcoder-errors.org +++ b/content/blog/2023-07-19-plex-transcoder-errors.md @@ -1,67 +1,63 @@ -#+title: How to Fix Plex Error: 'Conversion failed. The transcoder failed to start up.' -#+date: 2023-07-19 ++++ +date = 2023-07-19 +title = "How to Avoid Plex Error: 'Conversion failed. The transcoder failed to start up.'" +description = "Learn how to avoid Plex conversion errors caused by subtitles." ++++ + +## Plex Transcoder Error -** Plex Transcoder Error -:PROPERTIES: -:CUSTOM_ID: plex-transcoder-error -:END: Occasionally, you may see an error in your Plex client that references a failure with the transcoder conversion process. The specific error wording is: -#+begin_src txt +```txt Conversion failed. The transcoder failed to start up. -#+end_src +``` + +## Debugging the Cause -** Debugging the Cause -:PROPERTIES: -:CUSTOM_ID: debugging-the-cause -:END: -In order to get a better look at what is causing the error, I'm going to -observe the Plex console while the error occurs. To do this, open the -Plex web client, go to =Settings= > =Manage= > =Console=. Now, try to -play the title again and watch to see which errors occur. +In order to get a better look at what is causing the error, I'm going +to observe the Plex console while the error occurs. To do this, open the +Plex web client, go to `Settings` > `Manage` > +`Console`. Now, try to play the title again and watch to see +which errors occur. In my case, you can see the errors below are related to a subtitle file -(=.srt=) causing the transcoder to crash. +(`.srt`) causing the transcoder to crash. -#+begin_src txt +```txt Jul 19, 2023 16:49:34.945 [140184571120440] Error — Couldn't find the file to stream: /movies/Movie Title (2021)/Movie Title (2021).srt Jul 19, 2023 16:49:34.947 [140184532732728] Error — [Req#7611/Transcode/42935159-67C1-4192-9336-DDC6F7BC9330] Error configuring transcoder: TPU: Failed to download sub-stream to temporary file Jul 19, 2023 16:49:35.225 [140184532732728] Warning — [Req#760d/Transcode] Got a request to stop a transcode session without a valid session GUID. Jul 19, 2023 16:49:45.561 [140184532732728] Info — [Req#7648] AutoUpdate: no updates available Jul 19, 2023 16:51:23.402 [140184510081848] Info — Library section 1 (Movies) will be updated because of a change in "/movies/Movie Title (2021)/Movie Title (2021).srt" -#+end_src +``` + +## Solving the Error -** Solving the Error -:PROPERTIES: -:CUSTOM_ID: solving-the-error -:END: In my case, I simply removed the subtitle file because it was not critical to keep. You may also avoid this by turning off subtitles if you don't want to delete the file. -#+begin_src sh +```sh rm -rf "/movies/Movie Title (2021)/Movie Title (2021).srt" -#+end_src +``` Once the subtitle is removed from the directory or subtitles are turned off, try to play the title again. At this point, it should play without error. If not, reopen or refresh your Plex client and the Plex server: -#+begin_src sh +```sh sudo systemctl restart plexmediaserver.service -#+end_src +``` + +## Related Discussion -** Related Discussion -:PROPERTIES: -:CUSTOM_ID: related-discussion -:END: -Looking at -[[https://forums.plex.tv/t/subtitles-crashing-plex-transcoder-samsung-q80-tv-with-or-without-hardware-transcode/741441/2][a -related Plex forum post]], it seems that =.srt= subtitles are the core -issue here. However, Plex does not seem to have a resolution that fixes -these errors. +Looking at [a related Plex forum +post](https://forums.plex.tv/t/subtitles-crashing-plex-transcoder-samsung-q80-tv-with-or-without-hardware-transcode/741441/2), +it seems that `.srt` subtitles are the core issue here. +However, Plex does not seem to have a resolution that fixes these +errors. Unfortunately, I would suggest converting subtitle formats, burning the subtitles into the title, or simply removing subtitles when they cause diff --git a/content/blog/2023-08-18-agile-auditing.md b/content/blog/2023-08-18-agile-auditing.md new file mode 100644 index 0000000..f813596 --- /dev/null +++ b/content/blog/2023-08-18-agile-auditing.md @@ -0,0 +1,158 @@ ++++ +date = 2023-08-18 +title = "Agile Auditing: An Introduction" +description = "A quick introduction to using the Agile methodology in an audit." ++++ + +## What is Agile Auditing? + +[Agile](https://en.wikipedia.org/wiki/Agile_software_development), the +collaborative philosophy behind many software development methods, has +been picking up steam as a beneficial tool to use in the external and +internal auditing world. + +This blog post will walk through commonly used terms within Agile, +Scrum, and Kanban in order to translate these terms and roles into +audit-specific terms. + +Whether your team is in charge of a financial statement audit, an +attestation (SOC 1, SOC 2, etc.), or a unique internal audit, the terms +used throughout this post should still apply. + +## Agile + +To start, I'll take a look at Agile. + +> The Agile methodology is a project management approach that involves +> breaking the project into phases and emphasizes continuous +> collaboration and improvement. Teams follow a cycle of planning, +> executing, and evaluating. + +While this approach may seem familiar to what audit teams have +historically done, an audit team must make distinct changes in their +mentality and how they approach and manage a project. + +### Agile Values + +The Agile Manifesto, written in 2001 at a summit in Utah, contain a set +of four main values that comprise the Agile approach: + +1. Individuals and interactions over processes and tools. +2. Working software over comprehensive documentation. +3. Customer collaboration over contract negotiation. +4. Responding to change over following a plan. + +Beyond the four values, [twelve +principles](https://agilemanifesto.org/principles.html) were also +written as part of the summit. + +In order to relate these values to an audit or attestation engagement, +we need to shift the focus from software development to the main goal of +an engagement: completing sufficient audit testing to address to +relevant risks over the processes and controls at hand. + +Audit Examples: + +- Engagement teams must value the team members, client contacts, and + their interactions over the historical processes and tools that have + been used. +- Engagement teams must value a final report that contains sufficient + audit documentation over excessive documentation or scope creep. +- Engagement teams must collaborate with the audit clients as much as + feasible to ensure that both sides are constantly updated with + current knowledge of the engagement's status and any potential + findings, rather than waiting for pre-set meetings or the end of the + engagement to communicate. +- Engagement teams must be able to respond to change in an + engagement's schedule, scope, or environment to ensure that the + project is completed in a timely manner and that all relevant areas + are tested. + - In terms of an audit department's portfolio, they must be able + to respond to changes in their company's or client's + environment and be able to dynamically change their audit plan + accordingly. + +## Scrum + +The above section discusses the high-level details of the Agile +philosophy and how an audit team can potentially mold that mindset into +the audit world, but how does a team implement these ideas? + +There are many methods that use an Agile mindset, but I prefer +[Scrum](https://en.wikipedia.org/wiki/Scrum_(software_development)). +Scrum is a framework based on Agile that enables a team to work through +a project through a series of roles, ceremonies, artifacts, and values. + +Let's dive into each of these individually. + +### Scrum Team + +A scrum project is only as good as the team running the project. +Standard scrum teams are separated into three distinct areas: + +1. **Product Owner (Client Contact)**: The client contact is the audit + equivalent of the product owner in Scrum. They are responsible for + partnering with the engagement or audit team to ensure progress is + being made, priorities are established, and clear guidance is given + when questions or findings arise within each sprint. +2. **Scrum Master (Engagement Lead)**: The engagement or audit team + lead is responsible for coaching the team and the client contact on + the scrum process, tracking team progress against plan, scheduling + necessary resources, and helping remove obstacles. +3. **Scrum Developers (Engagement Members)**: The engagement or audit + team is the set of team members responsible for getting the work + done. These team members will work on each task, report progress, + resolve obstacles, and collaborate with other team members and the + client contact to ensure goals are being met. + +### Scrum Ceremonies + +Scrum ceremonies are events that are performed on a regular basis. + +1. **Sprint Planning**: The team works together to plan the upcoming + sprint goal and which user stories (tasks) will be added to the + sprint to achieve that goal. +2. **Sprint**: The time period, typically at least one week and no more + than one month in length, where the team works on the stories and + anything in the backlog. +3. **Daily Scrum**: A very short meeting held each day, typically 15 + minutes, to quickly emphasize alignment on the sprint goal and plan + the next 24 hours. Each team member may share what they did the day + before, what they'll do today, and any obstacles to their work. +4. **Sprint Review**: At the end of each sprint, the team will gather + and discuss the progress, obstacles, and backlog from the previous + sprint. +5. **Sprint Retrospective**: More specific than the sprint review, the + retrospective is meant to discuss what worked and what did not work + during the sprint. This may be processes, tools, people, or even + things related to the Scrum ceremonies. + +One additional ceremony that may be applicable is organizing the +backlog. This is typically the responsibility of the engagement leader +and is meant to prioritize and clarify what needs to be done to complete +items in the backlog. + +### Artifacts + +While artifacts are generally not customizable in the audit world (i.e., +each control test must include some kind of working paper with evidence +supporting the test results), I wanted to include some quick notes on +associating scrum artifact terms with an audit. + +1. **Product Backlog**: This is the overall backlog of unfinished audit + tasks from all prior sprints. +2. **Sprint Backlog**: This is the backlog of unfinished audit tasks + from one individual sprint. +3. **Increment**: This is the output of each sprint - generally this is + best thought of as any documentation prepared during the sprint, + such as risk assessments, control working papers, deficiency + analysis, etc. + +## Kanban + +Last but not least, Kanban is a methodology that relies on boards to +categorize work into distinct, descriptive categories that allow an +agile or scrum team to effectively plan the work of a sprint or project. + +See Atlassian's [Kanban](https://www.atlassian.com/agile/kanban) page +for more information. diff --git a/blog/2023-09-15-gitweb.org b/content/blog/2023-09-15-gitweb.md index 22c4c27..8952cdb 100644 --- a/blog/2023-09-15-gitweb.org +++ b/content/blog/2023-09-15-gitweb.md @@ -1,13 +1,15 @@ -#+title: GitWeb via Nginx -#+date: 2023-09-16 - -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: -[[https://git-scm.com/book/en/v2/Git-on-the-Server-GitWeb][GitWeb]] is a ++++ +date = 2023-09-15 +title = "GitWeb via Nginx" +description = "A guide to self-hosting GitWeb using the Nginx web server." ++++ + +## Overview + +[GitWeb](https://git-scm.com/book/en/v2/Git-on-the-Server-GitWeb) is a simple web-based visualizer for git repositories. By default, GitWeb -will only run with the =lighttpd= or =webrick= web servers. +will only run with the `lighttpd` or `webrick` web +servers. However, this guide will show you how to keep GitWeb running in the background and display information for all repositories in a chosen @@ -15,30 +17,25 @@ directory. See below for the final result: -#+caption: Gitweb -[[https://img.cleberg.net/blog/20230915-gitweb/gitweb.png]] + + +## Install Dependencies -** Install Dependencies -:PROPERTIES: -:CUSTOM_ID: install-dependencies -:END: To start, you'll need install the following packages: -#+begin_src sh +```sh sudo apt install git gitweb fcgiwrap nginx -#+end_src +``` + +## Configure Nginx -** Configure Nginx -:PROPERTIES: -:CUSTOM_ID: configure-nginx -:END: Once installed, create an Nginx configuration file. -#+begin_src sh +```sh sudo nano /etc/nginx/sites-available/git.example.com -#+end_src +``` -#+begin_src conf +```conf server { listen 80; server_name example.com; @@ -57,26 +54,24 @@ server { index index.cgi; } } -#+end_src +``` To make the configuration active, you need to symlink it and then restart Nginx. -#+begin_src sh +```sh sudo ln -s /etc/nginx/sites-available/git.example.com /etc/nginx/sites-enabled/git.example.com sudo systemctl restart nginx.service -#+end_src +``` The GitWeb application should now be available via the URL you set in the Nginx configuration above. -** Customize GitWeb -:PROPERTIES: -:CUSTOM_ID: customize-gitweb -:END: +## Customize GitWeb + If you need to, you can customize many things about Gitweb by editing -the [[https://git-scm.com/docs/gitweb.conf][gitweb.conf]] file. +the [gitweb.conf](https://git-scm.com/docs/gitweb.conf) file. -#+begin_src sh +```sh sudo nano /etc/gitweb.conf -#+end_src +``` diff --git a/blog/2023-09-19-audit-sql-scripts.org b/content/blog/2023-09-19-audit-sql-scripts.md index 3ab4b2a..109aca4 100644 --- a/blog/2023-09-19-audit-sql-scripts.org +++ b/content/blog/2023-09-19-audit-sql-scripts.md @@ -1,25 +1,24 @@ -#+title: Useful SQL Scripts for Auditing Logical Access -#+date: 2023-09-20 ++++ +date = 2023-09-19 +title = "Useful SQL Scripts for Auditing Logical Access" +description = "A reference of SQL scripts for auditing logical access for common databases." ++++ + +## Overview -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: When you have to scope a database into your engagement, you may be curious how to best extract the information from the database. While there are numerous different methods to extract this type of -information, I'm going to show an example of how to gather all users and -privileges from three main database types: Oracle, Microsoft SQL, and -MySQL. +information, I'm going to show an example of how to gather all users +and privileges from three main database types: Oracle, Microsoft SQL, +and MySQL. + +## Oracle -** Oracle -:PROPERTIES: -:CUSTOM_ID: oracle -:END: You can use the following SQL script to see all users and their privileges in an Oracle database: -#+begin_src sql +```sql SELECT grantee AS "User", privilege AS "Privilege" @@ -35,43 +34,40 @@ FROM dba_tab_privs WHERE grantee IN (SELECT DISTINCT grantee FROM dba_tab_privs); -#+end_src +``` -This script queries the =dba_sys_privs= and =dba_tab_privs= views to -retrieve system and table-level privileges respectively. It then -combines the results using =UNION ALL= to show all users and their -associated privileges. Please note that this method does not extract -information from the =dba_role_privs= table - use the method below for +This script queries the `dba_sys_privs` and +`dba_tab_privs` views to retrieve system and table-level +privileges respectively. It then combines the results using +`UNION ALL` to show all users and their associated +privileges. Please note that this method does not extract information +from the `dba_role_privs` table - use the method below for that data. Please note that you might need appropriate privileges (e.g., DBA privileges) to access these views, and you should exercise caution when querying system tables in a production Oracle database. -*** Alternative Oracle Query -:PROPERTIES: -:CUSTOM_ID: alternative-oracle-query -:END: +### Alternative Oracle Query + You can also extract each table's information separately and perform processing outside the database to explore and determine the information necessary for the audit: -#+begin_src sql +```sql SELECT * FROM sys.dba_role_privs; SELECT * FROM sys.dba_sys_privs; SELECT * FROM sys.dba_tab_privs; SELECT * FROM sys.dba_users; -#+end_src +``` + +## Microsoft SQL -** Microsoft SQL -:PROPERTIES: -:CUSTOM_ID: microsoft-sql -:END: You can use the following SQL script to see all users and their privileges in a Microsoft SQL Server database -([[https://stackoverflow.com/a/30040784][source]]): +([source](https://stackoverflow.com/a/30040784)): -#+begin_src sql +```sql /* Security Audit Report 1) List all access provisioned to a sql user or windows user/group directly @@ -216,47 +212,45 @@ ORDER BY perm.[permission_name], perm.[state_desc], obj.type_desc--perm.[class_desc] -#+end_src +``` + +## MySQL -** MySQL -:PROPERTIES: -:CUSTOM_ID: mysql -:END: You can use the following SQL script to see all users and their privileges in a MySQL database: -#+begin_src shell +```sh mysql -u root -p -#+end_src +``` Find all users and hosts with access to the database: -#+begin_src sql +```sql SELECT * FROM information_schema.user_privileges; -#+end_src +``` This script retrieves user information and their associated -database-level privileges from the =information_schema.user_privileges= -table in MySQL. It lists various privileges such as SELECT, INSERT, -UPDATE, DELETE, CREATE, and more for each user and database combination. +database-level privileges from the +`information_schema.user_privileges` table in MySQL. It lists +various privileges such as SELECT, INSERT, UPDATE, DELETE, CREATE, and +more for each user and database combination. -Please note that you may need appropriate privileges (e.g., =SELECT= -privileges on =information_schema.user_privileges=) to access this +Please note that you may need appropriate privileges (e.g., +`SELECT` privileges on +`information_schema.user_privileges`) to access this information in a MySQL database. Additionally, some privileges like GRANT OPTION, EXECUTE, EVENT, and TRIGGER may not be relevant for all users and databases. -*** Alternative MySQL Query -:PROPERTIES: -:CUSTOM_ID: alternative-mysql-query -:END: +### Alternative MySQL Query + You can also grab individual sets of data from MySQL if you prefer to join them after extraction. I have marked the queries below with -=SELECT ...= and excluded most =WHERE= clauses for brevity. You should -determine the relevant privileges in-scope and query for those -privileges to reduce the length of time to query. +`SELECT ...` and excluded most `WHERE` clauses for +brevity. You should determine the relevant privileges in-scope and query +for those privileges to reduce the length of time to query. -#+begin_src sql +```sql -- Global Permissions SELECT ... FROM mysql.user; @@ -275,4 +269,4 @@ WHERE db = @db_name; -- Password Configuration SHOW GLOBAL VARIABLES LIKE 'validate_password%'; SHOW VARIABLES LIKE 'validate_password%'; -#+end_src +``` diff --git a/content/blog/2023-10-04-digital-minimalism.md b/content/blog/2023-10-04-digital-minimalism.md new file mode 100644 index 0000000..63259dd --- /dev/null +++ b/content/blog/2023-10-04-digital-minimalism.md @@ -0,0 +1,106 @@ ++++ +date = 2023-10-04 +title = "Digital Minimalism" +description = "My personal retrospective on digital minimalism." ++++ + +I've written [a note about minimalism](/wiki/#digital-garden) +before, but I wanted to dedicate some time to reflect on digital +minimalism and how I've been able to minimize the impact of digital +devices in my life. + +> These changes crept up on us and happened fast, before we had a chance +> to step back and ask what we really wanted out of the rapid advances +> of the past decade. We added new technologies to the periphery of our +> experience for minor reasons, then woke one morning to discover that +> they had colonized the core of our daily life. We didn't, in other +> words, sign up for the digital world in which we're currently +> entrenched; we seem to have stumbled backward into it. +> +> *(Digital Minimalism, 2019)* + +## The Principles of Digital Minimalism + +As noted in Cal Newport's book, *Digital Minimalism*, there are three +main principles to digital minimalism that I tend to agree with: + +1. Clutter is costly. + - Digital minimalists recognize that cluttering their time and + attention with too many devices, apps, and services creates an + overall negative cost that can swamp the small benefits that + each individual item provides in isolation. +2. Optimization is important. + - Digital minimalists believe that deciding a particular + technology supports something they value is only the first step. + To truly extract its full potential benefit, it's necessary to + think carefully about how they'll use the technology. +3. Intentionality is satisfying. + - Digital minimalists derive significant satisfaction from their + general commitment to being more intentional about how they + engage with new technologies. This source of satisfaction is + independent of the specific decisions they make and is one of + the biggest reasons that minimalism tends to be immensely + meaningful to its practitioners. + +## Taking Action + +In order to put the logic into practice, I've created a few new habits +and continued performing old habits that are working well: + +### Using Devices With Intention + +- I already rarely use "social media", mostly limited to forums such + as Hacker News and Tildes, so I've just tweaked my behavior to stop + looking for content in those places when I'm bored. +- Use devices with intention. Each time I pick up a digital device, + there should be an intention to use the device to improve my current + situation. No more endless scrolling or searching for something to + interest me. + +### Prevent Distractions + +- Disable (most) notifications on all devices. I spent 15-30 minutes + going through the notifications on my phone, watch, and computer to + ensure that only a select few apps have the ability to interrupt me: + Calendar, Messages, Phone, Reminders, & Signal. +- Disable badges for any apps except the ones mentioned in the bullet + above. +- Set-up focus profiles across devices so that I can enable different + modes, such as Personal when I only want to see notifications from + people I care about or Do Not Disturb, where absolutely nothing can + interrupt me. +- Clean up my home screens. This one was quite easy as I already + maintain a minimalist set-up, but I went extreme by limiting my + phone to just eight apps on the home screen and four in the dock. If + I need another app, I'll have to search or use the app library. +- Remove the work profile from my phone. This was a tough decision as + having my work profile on my device definitely makes my life easier + at times, but it also has quite a negative effect when I'm "always + online" and can see the notifications and team activity 24/7. I + believe creating a distinct barrier between my work and personal + devices will be beneficial in the end. + +### Creating Alternative Activities + +This is the most difficult piece, as most of my hobbies and interests +lie in the digital world. However, I'm making a concerted effort to put +devices down unless necessary and force myself to perform other +activities in the physical world instead. + +I've started with a few basics that are always readily available to me: + +- Do a chore, such as organizing or cleaning. +- Read a book, study a piece of art, etc. +- Exercise or get outdoors. +- Participate in a hobby, such as photography, birding, disc golf, + etc. +- Let yourself be bored and wander into creativity. + +## Making Progress + +I'll be taking notes as I continue down this journey and hope to see +positive trends. I've always been a minimalist in the physical world +and it feels refreshing to filter out the clutter that has come to +dominate my digital life over the years. + +I'm excited to see where this journey leads. diff --git a/blog/2023-10-11-self-hosting-authelia.org b/content/blog/2023-10-11-self-hosting-authelia.md index 139f6a6..5794d21 100644 --- a/blog/2023-10-11-self-hosting-authelia.org +++ b/content/blog/2023-10-11-self-hosting-authelia.md @@ -1,59 +1,56 @@ -#+title: Self-Hosting Authelia -#+date: 2023-10-11 ++++ +date = 2023-10-11 +title = "Self-Hosting Authelia" +description = "A guide to self-hosting the Authelia application on your own server." ++++ -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: -[[https://www.authelia.com/][Authelia]] is an open-source authentication service that allows you to place a -portal between end users on the internet and self-hosted services on your -server. +## Overview -You can require one factor (username+password) or two factor authentication for -any such user before allowing them to access a specific service on your domain. +[Authelia](https://www.authelia.com/) is an open-source authentication +service that allows you to place a portal between end users on the +internet and self-hosted services on your server. + +You can require one factor (username+password) or two factor +authentication for any such user before allowing them to access a +specific service on your domain. This guide will walk through a standard installation of Authelia for -=example.com=, using =auth.example.com= as Authelia's authentication domain and -=teddit.example.com= as the website we want to protect behind the authentication -portal. - -** Prerequisites -:PROPERTIES: -:CUSTOM_ID: prerequisites -:END: +`example.com`, using `auth.example.com` as +Authelia's authentication domain and `teddit.example.com` as +the website we want to protect behind the authentication portal. + +## Prerequisites + This guide assumes you have the following already set-up: -- A registered domain with DNS pointing to your server. -- A subdomain for Authelia (=auth.example.com=) and a subdomain to - protect via Authelia (=app.example.com=). -- A working Nginx web server. -- Docker and docker-compose installed. - -** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: -This guide will walk through each installation step one-by-one, starting with -the container and finishing by cleaning up external access via an Nginx reverse -proxy. - -*** Docker-Compose -:PROPERTIES: -:CUSTOM_ID: docker-compose -:END: +- A registered domain with DNS pointing to your server. +- A subdomain for Authelia (`auth.example.com`) and a + subdomain to protect via Authelia (`app.example.com`). +- A working Nginx web server. +- Docker and docker-compose installed. + +## Installation + +This guide will walk through each installation step one-by-one, starting +with the container and finishing by cleaning up external access via an +Nginx reverse proxy. + +### Docker-Compose + To start, create a directory for Authelia and create a -=docker-compose.yml= file. +`docker-compose.yml` file. -#+begin_src sh +```sh mkdir ~/authelia nano ~/authelia/docker-compose.yml -#+end_src +``` -Within this file, paste the following content. If you prefer a different local -port, modify the port on the left side of the colon on the =9091:9091= line. Be -sure to modify the =TZ= variable to your timezone. +Within this file, paste the following content. If you prefer a different +local port, modify the port on the left side of the colon on the +`9091:9091` line. Be sure to modify the `TZ` +variable to your timezone. -#+begin_src yml +```yml version: '3.3' services: @@ -66,52 +63,55 @@ services: - 9091:9091 environment: - TZ=America/Chicago -#+end_src +``` Start the container with docker-compose: -#+begin_src sh +```sh sudo docker-compose up -d -#+end_src +``` + +After the first start, the container will automatically exit and require +you to modify the app's configuration files before continuing. Read on +to learn more. -After the first start, the container will automatically exit and require you to -modify the app's configuration files before continuing. Read on to learn more. +### Authelia Configuration -*** Authelia Configuration -:PROPERTIES: -:CUSTOM_ID: authelia-configuration -:END: -To configure Authelia before we restart the container, we need to open the -=config= directory and modify the files. Start by editing the -=configuration.yml= file, where all of Authelia's settings are stored. +To configure Authelia before we restart the container, we need to open +the `config` directory and modify the files. Start by editing +the `configuration.yml` file, where all of Authelia's +settings are stored. -My personal preference is to copy the original configuration file to a backup -file and edit a fresh copy. +My personal preference is to copy the original configuration file to a +backup file and edit a fresh copy. -#+begin_src sh +```sh sudo cp ~/authelia/config/configuration.yml ~/authelia/config/configuration.yml.bk sudo nano ~/authelia/config/configuration.yml -#+end_src +``` -Within the blank =configuration.yml= file, paste the following information. You -will need to make quite a few updates, so be sure to read each line carefully -and modify as necessary. +Within the blank `configuration.yml` file, paste the +following information. You will need to make quite a few updates, so be +sure to read each line carefully and modify as necessary. The major required changes are: -- Any instances of =example.com= should be replaced by your domain. -- =jwt_secret= - Use the =pwgen 40 1= command to generate a secret for yourself. -- =access_control= - Set the Authelia domain to bypass here, as well as any - subdomains you want to protect. -- =session= > =secret= - Use the =pwgen 40 1= command to generate a secret for - yourself. -- =regulation= - Set the variables here to restrict login attempts and bans. -- =storage= > =encryption_key= - Use the =pwgen 40 1= command to generate a - secret for yourself. -- =smtp= - If you have access to an SMTP service, set up the information here to - active outgoing emails. - -#+begin_src yml +- Any instances of `example.com` should be replaced by your + domain. +- `jwt_secret` - Use the `pwgen 40 1` command to + generate a secret for yourself. +- `access_control` - Set the Authelia domain to bypass + here, as well as any subdomains you want to protect. +- `session` > `secret` - Use the + `pwgen 40 1` command to generate a secret for yourself. +- `regulation` - Set the variables here to restrict login + attempts and bans. +- `storage` > `encryption_key` - Use the + `pwgen 40 1` command to generate a secret for yourself. +- `smtp` - If you have access to an SMTP service, set up + the information here to active outgoing emails. + +```yml # yamllint disable rule:comments-indentation --- ############################################################################### @@ -200,27 +200,26 @@ notifier: skip_verify: false minimum_version: TLS1.2 ... -#+end_src +``` + +### Authelia Users -*** Authelia Users -:PROPERTIES: -:CUSTOM_ID: authelia-users -:END: Next, create the users file for authentication. -#+begin_src sh +```sh sudo nano ~/authelia/config/users_database.yml -#+end_src +``` -Within the file, you will need to create an entry for each user that needs -access to Authelia. The =my_username= entry will be the username used on the -login page. +Within the file, you will need to create an entry for each user that +needs access to Authelia. The `my_username` entry will be the +username used on the login page. -To generate the password, go to [[https://argon2.online][Argon2 Hash Generator]], generate a random salt, -and make sure the rest of the settings match the =authentication_backend= -section of =configuration.yml= file. +To generate the password, go to [Argon2 Hash +Generator](https://argon2.online), generate a random salt, and make sure +the rest of the settings match the `authentication_backend` +section of `configuration.yml` file. -#+begin_src yml +```yaml users: my_username: displayname: "My User" @@ -231,33 +230,32 @@ users: groups: - admins - dev -#+end_src +``` Once the app is configured, restart the container from scratch. -#+begin_src sh +```sh cd ~/authelia sudo docker-compose down && sudo docker-compose up -d -#+end_src +``` -*** Nginx: Authelia Domain -:PROPERTIES: -:CUSTOM_ID: nginx-authelia-domain -:END: -Once the container is running and configured, the final step is to configure -external access to the server via Nginx reverse proxy. +### Nginx: Authelia Domain + +Once the container is running and configured, the final step is to +configure external access to the server via Nginx reverse proxy. Start by creating the Authelia domain. -#+begin_src sh +```sh sudo nano /etc/nginx/sites-available/auth -#+end_src +``` Within this file, paste the following information and be sure to update -=example.com= to your domain. Make sure the =$upstream_authelia= variable -matches the location of your Authelia container. +`example.com` to your domain. Make sure the +`$upstream_authelia` variable matches the location of your +Authelia container. -#+begin_src conf +```conf server { if ($host ~ ^[^.]+\.example\.com$) { return 301 https://$host$request_uri; @@ -309,32 +307,30 @@ server { } } -#+end_src +``` -Next, symlink the file and restart Nginx. If there are errors, be sure to -resolve those before moving on. +Next, symlink the file and restart Nginx. If there are errors, be sure +to resolve those before moving on. -#+begin_src sh +```sh sudo ln -s /etc/nginx/sites-available/auth /etc/nginx/sites-enabled/auth sudo systemctl restart nginx.service -#+end_src +``` + +### Nginx: Protected Domain(s) -*** Nginx: Protected Domain(s) -:PROPERTIES: -:CUSTOM_ID: nginx-protected-domains -:END: -Now that Authelia is accessible externally, you need to configure the domain you -intend to protect with Authelia. In this example, I'm protecting -=teddit.example.com=. +Now that Authelia is accessible externally, you need to configure the +domain you intend to protect with Authelia. In this example, I'm +protecting `teddit.example.com`. Similar to the process above, paste the content and update the relevant variables. -#+begin_src sh +```sh sudo nano /etc/nginx/sites-available/teddit -#+end_src +``` -#+begin_src conf +```conf server { if ($host ~ ^[^.]+\.example\.com$) { return 301 https://$host$request_uri; @@ -436,28 +432,26 @@ server { proxy_buffers 64 256k; } } -#+end_src +``` Same as before, symlink the file and restart Nginx. -#+begin_src sh +```sh sudo ln -s /etc/nginx/sites-available/teddit /etc/nginx/sites-enabled/teddit sudo systemctl restart nginx.service -#+end_src +``` + +## Results -** Results -:PROPERTIES: -:CUSTOM_ID: results -:END: When visiting the protected domain, you will now be redirected to your authentication domain and presented with the Authelia login portal. -#+caption: Authelia Portal -[[https://img.cleberg.net/blog/20231010-authelia/authelia_portal.png]] + -Once you've successfully authenticated, you can visit your authentication domain -directly and see that you're currently authenticated to any domain protected by -Authelia. +Once you've successfully authenticated, you can visit your +authentication domain directly and see that you're currently +authenticated to any domain protected by Authelia. -#+caption: Authelia Success -[[https://img.cleberg.net/blog/20231010-authelia/authelia_success.png]] + diff --git a/blog/2023-10-15-alpine-ssh-hardening.org b/content/blog/2023-10-15-alpine-ssh-hardening.md index 03a3ba7..e1c555c 100644 --- a/blog/2023-10-15-alpine-ssh-hardening.org +++ b/content/blog/2023-10-15-alpine-ssh-hardening.md @@ -1,74 +1,74 @@ -#+title: SSH Hardening for Alpine Linux -#+date: 2023-10-16 ++++ +date = 2023-10-15 +title = "SSH Hardening for Alpine Linux" +description = "A quick guide to harden SSH configuration on Alpine." ++++ + +## Overview -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: This guide follows the standard -[[https://www.ssh-audit.com/hardening_guides.html][ssh-audit]] hardening +[ssh-audit](https://www.ssh-audit.com/hardening_guides.html) hardening guide, tweaked for Alpine Linux. -** Hardening Guide -:PROPERTIES: -:CUSTOM_ID: hardening-guide -:END: -These steps must be performed as root. You can try to use =doas= or -=sudo=, but there may be issues. +## Hardening Guide + +These steps must be performed as root. You can try to use +`doas` or `sudo`, but there may be issues. -1. Re-generate the RSA and ED25519 keys +1. Re-generate the RSA and ED25519 keys -#+begin_src sh +```sh rm /etc/ssh/ssh_host_* ssh-keygen -t rsa -b 4096 -f /etc/ssh/ssh_host_rsa_key -N "" ssh-keygen -t ed25519 -f /etc/ssh/ssh_host_ed25519_key -N "" -#+end_src +``` -2. [@2] Remove small Diffie-Hellman moduli +2. Remove small Diffie-Hellman moduli -#+begin_src sh +```sh awk '$5 >= 3071' /etc/ssh/moduli > /etc/ssh/moduli.safe mv /etc/ssh/moduli.safe /etc/ssh/moduli -#+end_src +``` -3. [@3] Enable the RSA and ED25519 HostKey directives in the - /etc/ssh/sshd_config file +3. Enable the RSA and ED25519 HostKey directives in the + /etc/ssh/sshd~config~ file -#+begin_src sh +```sh sed -i 's/^\#HostKey \/etc\/ssh\/ssh_host_\(rsa\|ed25519\)_key$/HostKey \/etc\/ssh\/ssh_host_\1_key/g' /etc/ssh/sshd_config -#+end_src +``` -4. [@4] Restrict supported key exchange, cipher, and MAC algorithms +4. Restrict supported key exchange, cipher, and MAC algorithms -#+begin_src sh +```sh echo -e "\n# Restrict key exchange, cipher, and MAC algorithms, as per sshaudit.com\n# hardening guide.\nKexAlgorithms sntrup761x25519-sha512@openssh.com,curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,diffie-hellman-group-exchange-sha256\nCiphers chacha20-poly1305@openssh.com,aes256-gcm@openssh.com,aes128-gcm@openssh.com,aes256-ctr,aes192-ctr,aes128-ctr\nMACs hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,umac-128-etm@openssh.com\nHostKeyAlgorithms ssh-ed25519,ssh-ed25519-cert-v01@openssh.com,sk-ssh-ed25519@openssh.com,sk-ssh-ed25519-cert-v01@openssh.com,rsa-sha2-512,rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256,rsa-sha2-256-cert-v01@openssh.com" > /etc/ssh/sshd_config.d/ssh-audit_hardening.conf -#+end_src +``` -5. [@5] Include the /etc/ssh/sshd_config.d directory +5. Include the /etc/ssh/sshd~config~.d directory -#+begin_src sh +```sh echo -e "Include /etc/ssh/sshd_config.d/*.conf" > /etc/ssh/sshd_config -#+end_src +``` -6. [@6] Restart OpenSSH server +6. Restart OpenSSH server -#+begin_src sh +```sh rc-service sshd restart -#+end_src +``` -** Testing SSH -:PROPERTIES: -:CUSTOM_ID: testing-ssh -:END: -You can test the results with the =ssh-audit= python script. +## Testing SSH -#+begin_src sh +You can test the results with the `ssh-audit` python script. + +```sh pip3 install ssh-audit ssh-audit localhost -#+end_src +``` If everything succeeded, the results will show as all green. If anything is yellow, orange, or red, you may need to tweak additional settings. +```txt #+caption: ssh audit -[[https://img.cleberg.net/blog/20231015-ssh-hardening/ssh-audit.png%20%22ssh-audit%22]] +``` + + diff --git a/blog/2023-10-17-self-hosting-anonymousoverflow.org b/content/blog/2023-10-17-self-hosting-anonymousoverflow.md index 1acfb95..7b3b228 100644 --- a/blog/2023-10-17-self-hosting-anonymousoverflow.org +++ b/content/blog/2023-10-17-self-hosting-anonymousoverflow.md @@ -1,37 +1,35 @@ -#+title: Self-Hosting AnonymousOverflow -#+date: 2023-10-17 ++++ +date = 2023-10-17 +title = "Self-Hosting AnonymousOverflow" +description = "A guide to self-hosting the AnonymousOverflow application on your own server." ++++ -** Overview -:PROPERTIES: -:CUSTOM_ID: overview -:END: -I recently launched an instance of AnonymousOverflow at [[https://ao.cleberg.net][ao.cleberg.net]] and -wanted to write a brief post on how easy it is to install with Docker Compose -and Nginx. +## Overview + +I recently launched an instance of AnonymousOverflow at +[ao.cleberg.net](https://ao.cleberg.net) and wanted to write a brief +post on how easy it is to install with Docker Compose and Nginx. This guide uses Ubuntu server, Docker Compose, and Nginx as a reverse proxy. -** Installation -:PROPERTIES: -:CUSTOM_ID: installation -:END: -*** Docker Compose -:PROPERTIES: -:CUSTOM_ID: docker-compose -:END: +## Installation + +### Docker Compose + To install AnonymousOverflow, start by creating a directory for the -application and create its =docker-compose.yml= file. +application and create its `docker-compose.yml` file. -#+begin_src sh +```sh mkdir ~/anonymousoverflow && cd ~/anonymousoverflow nano docker-compose.yml -#+end_src +``` Within this file, paste the following information. Be sure to change the -=APP_URL=, =JWT_SIGNING_SECRET=, and =ports= to match your needs. +`APP_URL`, `JWT_SIGNING_SECRET`, and +`ports` to match your needs. -#+begin_src yaml +```yaml version: '3' services: @@ -44,33 +42,32 @@ services: ports: - '9380:8080' restart: 'always' -#+end_src +``` Save and exit the file when complete. You can now launch the container and access it via your local network. -#+begin_src sh +```sh sudo docker-compose up -d -#+end_src +``` + +### Nginx Reverse Proxy -*** Nginx Reverse Proxy -:PROPERTIES: -:CUSTOM_ID: nginx-reverse-proxy -:END: If you want to access this service outside the local network, I recommend using Nginx as a reverse proxy. Let's start by creating a configuration file. -#+begin_src sh +```sh sudo nano /etc/nginx/sites-available/ao -#+end_src +``` Within this file, paste the following content and repace -=ao.example.com= with your URL. You may need to update the SSL -certificate statements if your certificates are in a different location. +`ao.example.com` with your URL. You may need to update the +SSL certificate statements if your certificates are in a different +location. -#+begin_src conf +```conf server { if ($host ~ ^[^.]+\.cleberg\.net$) { return 301 https://$host$request_uri; @@ -122,15 +119,15 @@ server { proxy_buffers 64 256k; } } -#+end_src +``` -Save and exit the file when complete. On Ubuntu, you will need to symlink the -configuration file before it will be recognized by Nginx. Once complete, simply -restart the web server. +Save and exit the file when complete. On Ubuntu, you will need to +symlink the configuration file before it will be recognized by Nginx. +Once complete, simply restart the web server. -#+begin_src sh +```sh sudo ln -s /etc/nginx/sites-available/ao /etc/nginx/sites-enabled/ao sudo systemctl restart nginx.service -#+end_src +``` -The website will now be available publicly. Visit [[https://ao.cleberg.net][my instance]] for an example. +The website will now be available publicly. Visit [my instance](https://ao.cleberg.net) for an example. diff --git a/content/blog/2023-11-08-scli.md b/content/blog/2023-11-08-scli.md new file mode 100644 index 0000000..d3b26a7 --- /dev/null +++ b/content/blog/2023-11-08-scli.md @@ -0,0 +1,157 @@ ++++ +date = 2023-11-08 +title = "Installing scli on Alpine Linux (musl)" +description = "Learn how to properly configure scli for musl-based systems." ++++ + +[scli](https://github.com/isamert/scli) is a command-line tool that +allows you to connect to your Signal messenger account. This program +utilizes a two-pane display that shows you chats on the left and the +focused conversation on the right. + +This guide will show you how to install `scli` and its +dependencies on Alpine Linux, which requires some extra work due to +musl. + +If you're using a non-musl system, you can likely following the +`scli` README and download the packaged binaries for an +easier installation process. + +## Dependencies + +In order to use `scli`, you need a few dependencies: + +- `openjdk17-jre` - Used as a dependency for the + `signal-cli` tool. Version may vary. +- `signal-cli` - Used as the backbone of the + `scli` tool. +- `findutils` - Replaces the standard Busybox version of + `xargs`. +- `urwid` - A console user interface library for Python. +- `urwid-readline` - For GNU emacs-like keybinds on the + input line. +- `qrencode` - Displays a QR code in the terminal to link + the device using your phone. Not necessary if you're only linking + on desktop and can copy/paste the connection URL. + +Let's start by installing the packages available via Alpine's +repositories. Be sure to install the latest version of +`openjdk`. If you run into Java-related issues, uninstall +`openjdk` and install an older version. + +```sh +doas apk add openjdk17-jre findutils qrencode +``` + +Next, let's install `signal-cli`. Be sure to export the +version of `signal-cli` that you want. I use version +`0.12.4` below, but that may be outdated by the time you're +reading this. + +```sh +export VERSION="0.12.4" +wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz +doas tar xf signal-cli-"${VERSION}".tar.gz -C /opt +doas ln -sf /opt/signal-cli-${VERSION}"/bin/signal/cli /usr/local/bin +``` + +Finally, install the `urwid` packages using the Python +packaging utility. + +```sh +pip3 install urwid urwid-readline +``` + +## Installation + +Now that we have all of the dependencies we need, we can install +`scli`. Start by simply cloning the repository. + +```sh +git clone https://github.com/isamert/scli +``` + +When I cloned this repository on 2023-11-08, I found a bug in the logic +that required a fix. You must edit the `scli` file and +replace the one instance of `RLIMIT_OFILE` with +`RLIMIT_NOFILE`. + +```sh +cd scli +nano scli +``` + +Once complete, you can move this program to anywhere on your +`$PATH`. I chose the following directory. + +```sh +doas mv scli /usr/local/bin/scli +``` + +## Initial Setup + +Now that everything is installed, we can login and configure the client. +Start by generating a connection link. + +```sh +signal-cli link -n "YOUR-DEVICE-NICKNAME" | tee >(xargs -L 1 qrencode -t utf8) +``` + +This will generate a connection link and related QR code for you to use +to link the devices together. Once complete, **wait patiently** for the +connection process to finish. + +Once it completes, it will exit and return you to the prompt. From here, +you need to perform an initial `receive` command to start +things off. The `USERNAME` variable should be your phone +number, such as `+15551237890`. + +```sh +signal-cli -u USERNAME receive +``` + +Also be sure to test the daemon to ensure it works properly. If no +errors occur, it's working. If you run into errors because you're not +running a DBUS session, see my notes below. + +```sh +signal-cli -u USERNAME daemon +``` + +Once the initial reception is complete, you are ready to use +`scli`. + +This process will differ depending on your desktop environment (DE). If +you are running a DE, you likely have a DBUS session running already and +can simply launch the program. + +However, if you're like me and running your computer straight on the +TTY without a DE, you'll need to start a DBUS session for this program. + +```sh +# If you're not running a DBUS session yet, you need to start one for scli +dbus-run-session -- scli + +# OR - If you're already running a DBUS session, simply run scli +scli +``` + +## Configuration + +Lastly, there are a number of configuration options that you can pass +via the command or in the `~/.config/sclirc` file. See the +Github README for more information on configuration options. + +```sh +nano ~/.config/sclirc +``` + +```conf +# ~/.config/sclirc + +wrap-at = 80 +enable-notifications = true +``` + +That's it! Following this guide, I have a functional `scli` +program that successfully sends messages to my contacts and myself! diff --git a/blog/2023-12-03-unifi-nextdns.org b/content/blog/2023-12-03-unifi-nextdns.md index 4d790f9..b6bb627 100644 --- a/blog/2023-12-03-unifi-nextdns.org +++ b/content/blog/2023-12-03-unifi-nextdns.md @@ -1,128 +1,104 @@ -#+title: How to Install NextDNS on the Unifi Dream Machine -#+date: 2023-12-03 ++++ +date = 2023-12-03 +title = "How to Install NextDNS on the Unifi Dream Machine" +description = "A guide to properly install the NextDNS client on the UDM Pro." ++++ -* Overview -:PROPERTIES: -:ID: 711309AE-955D-4B2D-B716-CFD700079157 -:PUBDATE: 2023-12-03 Sun 22:32 -:END: +# Overview -I recently installed NextDNS on my Unifi Dream Machine router using the -[[https://github.com/nextdns/nextdns/wiki/UnifiOS][UnifiOS]] wiki page on +I recently installed NextDNS on my Unifi Dream Machine router using the +[UnifiOS](https://github.com/nextdns/nextdns/wiki/UnifiOS) wiki page on NextDNS's GitHub repository. -As a result of this, I wanted to write down the process in case the wiki or -installer ever gets lost. +As a result of this, I wanted to write down the process in case the wiki +or installer ever gets lost. -* Wiki -:PROPERTIES: -:ID: 8457B7A9-AE62-448D-B092-C04759F8D468 -:PUBDATE: 2023-12-03 Sun 22:32 -:END: +# Wiki -The following is copied from the wiki page linked above, with one difference in -the =ssh= command. +The following is copied from the wiki page linked above, with one +difference in the `ssh` command. -Install instructions for Unifi Dream Machine (UDM) standard and pro routers. +Install instructions for Unifi Dream Machine (UDM) standard and pro +routers. -** Install -:PROPERTIES: -:ID: 907F595C-6D53-409D-AB97-2B830D09B62E -:END: +## Install Enable SSH: -- Go to your unifi admin interface and select your device (not the controller - settings, but the Dream Machine settings) -- Click on "Settings" at the bottom of the page -- Go to the "Advanced" section on the left pan -- Enable SSH -- Set a SSH password +- Go to your unifi admin interface and select your device (not the + controller settings, but the Dream Machine settings) +- Click on "Settings" at the bottom of the page +- Go to the "Advanced" section on the left pan +- Enable SSH +- Set a SSH password -Connect to your router using =ssh root@xxx.xxx.xxx.xxx= with the password you -configured. +Connect to your router using `ssh root@xxx.xxx.xxx.xxx` with +the password you configured. Run the following command and follow the instructions: -#+begin_src sh +```sh sh -c 'sh -c "$(curl -sL https://nextdns.io/install)"' -#+end_src +``` -Note: Queries from the UDM itself won’t be routed to NextDNS nor encrypted due -to current system limitation. All traffic from other devices on then network -will. +Note: Queries from the UDM itself won't be routed to NextDNS nor +encrypted due to current system limitation. All traffic from other +devices on then network will. -** Upgrade -:PROPERTIES: -:ID: 3836C070-2C7C-456D-AB3B-15DDE60D2F99 -:END: +## Upgrade -To upgrade to the last version, simply re-run the installer above. If a new -version is available, the upgrade action will added to the list of possible -actions. +To upgrade to the last version, simply re-run the installer above. If a +new version is available, the upgrade action will added to the list of +possible actions. -** Uninstall -:PROPERTIES: -:ID: DFD1BA2F-EC4E-4B5C-9CEA-098DFF0AD62F -:END: +## Uninstall -To uninstall, re-run the installer above and select "Remove" in the menu. +To uninstall, re-run the installer above and select "Remove" in the +menu. -** Troubleshooting -:PROPERTIES: -:ID: 0B0F4E70-FACC-4C7C-8EB9-55398AA8476F -:END: +## Troubleshooting -If the installation fail, please the installer in debug mode and contact us at -team@nextdns.io with the transcript of the installation: +If the installation fail, please the installer in debug mode and contact +us at team@nextdns.io with the transcript of the installation: -#+begin_src sh +```sh sh -c 'DEBUG=1 sh -c "$(curl -sL https://nextdns.io/install)"' -#+end_src +``` -*** Content Filtering Conflict -:PROPERTIES: -:ID: BCDD3267-4C04-45AC-BAAD-9D15F414ED4D -:END: +### Content Filtering Conflict -NextDNS CLI and the UDM Content Filtering or the Ad Blocking features are -incompatible. If you want to use NextDNS CLI, please make sure they are -disabled. +NextDNS CLI and the UDM Content Filtering or the Ad Blocking features +are incompatible. If you want to use NextDNS CLI, please make sure they +are disabled. -To disable Content Filtering, go to Settings > Network, then for each network, -set the Content Filtering feature to None +To disable Content Filtering, go to Settings > Network, then for each +network, set the Content Filtering feature to None -To disable Ad Blocking, go to Settings > Application Firewall. In the General -tab, uncheck the Ad Blocking checkbox. +To disable Ad Blocking, go to Settings > Application Firewall. In the +General tab, uncheck the Ad Blocking checkbox. -*** APT Error -:PROPERTIES: -:ID: 83244A13-7154-475A-8193-064A1B81D3AE -:END: +### APT Error If you get an apt error as follow: -#+begin_src sh +```sh E: Failed to fetch http://security.debian.org/dists/stretch/updates/main/binary-arm64/Packages 404 Not Found [IP: 151.101.70.132 80] -#+end_src +``` You may try to following: -#+begin_src sh +```sh sed -i -e 's/deb.debian.org/archive.debian.org/g' \ -e 's|security.debian.org|archive.debian.org/|g' \ -e '/stretch-updates/d' /etc/apt/sources.list -#+end_src +``` -* install.sh -:PROPERTIES: -:ID: 91DE0DD0-8177-4594-B067-373ABF99C343 -:PUBDATE: 2023-12-03 Sun 22:34 -:END: +# install.sh -Here are the contents of the =install.sh= file used above, as of 2023-12-03: +Here are the contents of the `install.sh` file used above, as +of 2023-12-03: -#+begin_src sh +```sh #!/bin/sh main() { @@ -226,13 +202,13 @@ uninstall() { precheck() { if [ -e "/data/unifi" ] && [ -f "/run/dnsfilter/dnsfilter" ]; then log_warn "UDM Content Filtering and/or Ad Blocking feature is enabled." - log_warn "Please disable it to use NextDNS." + log_warn "Please disable it to use NextDNS." log_warn "" log_warn " To disable Content Filtering, go to Settings > Network." log_warn " For each network, set the Content Filtering feature to None." - log_warn "" - log_warn " To disable Ad Blocking, go to Settings > Application Firewall" - log_warn " In the General tab, uncheck the Ad Blocking checkbox." + log_warn "" + log_warn " To disable Ad Blocking, go to Settings > Application Firewall" + log_warn " In the General tab, uncheck the Ad Blocking checkbox." log_warn "" while [ -f "/run/dnsfilter/dnsfilter" ]; do sleep 1 @@ -359,7 +335,7 @@ install_bin() { esac log_debug "Downloading $url" asroot mkdir -p "$(dirname "$bin_path")" && - curl -sL "$url" | asroot sh -c "tar Ozxf - nextdns > \"$bin_path\"" && + curl -sL "$url" | asroot sh -c "tar Ozxf - nextdns > "$bin_path"" && asroot chmod 755 "$bin_path" } @@ -1163,9 +1139,9 @@ bin_location() { ;; synology) echo "/usr/local/bin/nextdns" - ;; + ;; darwin) - echo "$(brew --prefix 2>/dev/null || echo /usr/local)/bin/nextdns" + echo "$(brew --prefix 2>/dev/null || echo /usr/local)/bin/nextdns" ;; asuswrt-merlin|ddwrt) echo "/jffs/nextdns/nextdns" @@ -1272,4 +1248,4 @@ openssl_get() { umask 0022 main -#+end_src +``` diff --git a/content/blog/_index.md b/content/blog/_index.md new file mode 100644 index 0000000..74f5419 --- /dev/null +++ b/content/blog/_index.md @@ -0,0 +1,4 @@ ++++ +title = "Blog" +sort_by = "date" ++++
\ No newline at end of file diff --git a/content/salary/index.md b/content/salary/index.md new file mode 100644 index 0000000..43a9a91 --- /dev/null +++ b/content/salary/index.md @@ -0,0 +1,54 @@ ++++ +title = "Salary" +description = "A summary of my salaries throughout my career." ++++ + +# Salary Transparency + +The data below details the base salary information for each job I've +held. This information is posted publicly to ensure others in my +position have a solid reference point when determining if their current +or proposed salary is appropriate. + +While sites like Glassdoor are locking salary data behind a paywall, +LinkedIn is discontinuing LinkedIn Salary, and helpful websites like Big +4 Transparency are extremely rare, I wanted to provide my personal data +publicly and freely to those who need it. + +I have seen what can happen when great employees don't know the market +values for their skills and I happily help those in my teams, so I'm +happy to extend this information to the online community. + +As a final note, there are numerous reasons that people in the same role +are paid differently (expertise, years of experience, certifications, +education, etc.) and that the data in this table should only be used as +a single point of reference, not the whole story. + +# Salary Data + +Note: When in a role that gives periodic raises, I will create a new +record with the new base salary in the table below. See the KPMG records +for an example of a raise while in the same role. + +| Title | Company | Location | Start Date | End Date | Base Salary | +|---------------------------------------|------------------------|----------------|------------|----------|-------------| +| Senior Technology Assurance Associate | KPMG | Omaha, NE | 2023-10 | Current | \$116,700 | +| Senior Technology Assurance Associate | KPMG | Omaha, NE | 2022-06 | 2023-10 | \$110,000 | +| Senior Technology Risk Consultant | Ernst & Young | Des Moines, IA | 2021-09 | 2022-06 | \$89,500 | +| Senior IT Auditor | Ameritas | Lincoln, NE | 2021-05 | 2021-09 | \$72,000 | +| IT Auditor | Ameritas | Lincoln, NE | 2020-04 | 2021-05 | \$65,000 | +| IS Auditor II | Nelnet | Lincoln, NE | 2019-12 | 2020-04 | \$58,000 | +| IS Auditor I | Nelnet | Lincoln, NE | 2019-06 | 2019-12 | \$20/hour | +| Internal Audit Intern | Ameritas | Lincoln, NE | 2018-02 | 2019-06 | \$16/hour | +| Teaching Assistant | University of Nebraska | Lincoln, NE | 2017-08 | 2018-05 | \$7/hour | +| Community Management Intern | Walgreens | Lincoln, NE | 2017-06 | 2018-02 | \$14/hour | + +This page was inspired by [Xe](https://xeiaso.net/), and I'm quoting +the following wording from them as I want to reiterate this piece: + +> Please consider publishing your salary data like this as well. By +> open, voluntary transparency we can help to end stigmas around +> discussing pay and help ensure that the next generations of people in +> tech are treated fairly. Stigmas thrive in darkness but die in the +> light of day. You can help end the stigma by playing your cards out in +> the open like this. diff --git a/content/services/index.md b/content/services/index.md new file mode 100644 index 0000000..5b2ec55 --- /dev/null +++ b/content/services/index.md @@ -0,0 +1,17 @@ ++++ +title = "Services" +description = "Publicly-available services hosted on cleberg.net." ++++ + +- [AnonymousOverflow](https://ao.cleberg.net) - A StackOverflow proxy +- [CyberChef](https://cyberchef.cleberg.net) - The Cyber Swiss Army Knife +- [FileArchive](https://files.cleberg.net) - An interesting file archive +- [FlashPaper](https://paste.cleberg.net) - One-time encrypted password/secret sharing +- [GotHub](https://gh.cleberg.net) - An alternative front-end for GitHub +- [ifconfig.php](https://ip.cleberg.net) - A \"whatsmyip\" tool +- [Invidious](https://invidious.cleberg.net) - A YouTube proxy +- [Nitter](https://nitter.cleberg.net) - A Twitter proxy +- [Office](https://office.cleberg.net) - The world\'s smallest office suite +- [SearXNG](https://search.cleberg.net) - A privacy-respecting, open metasearch engine + +See the [git log](https://git.cleberg.net/?p=cleberg.net.git;a=history;f=services/index.org;h=71ed6bcae7e52a8103f980f1821ca291ef3010ba;hb=HEAD) for this page if you want to see changes that have been made. diff --git a/wiki/index.org b/content/wiki/index.md index f2b4482..a069c59 100644 --- a/wiki/index.org +++ b/content/wiki/index.md @@ -1,79 +1,80 @@ -#+title: Wiki ++++ +title = "Wiki" +description = "An informal wiki of sorts." ++++ An informal wiki of sorts. -* Digital Garden +# Digital Garden -#+BEGIN_QUOTE -At times, wilderness is exactly what readers want: a rich collection of -resources and links. At times, rigid formality suits readers perfectly, -providing precisely the information they want, no more and no less. Indeed, -individual hypertexts and Web sites may contain sections that tend toward -each extreme. -#+END_QUOTE +> At times, wilderness is exactly what readers want: a rich collection +> of resources and links. At times, rigid formality suits readers +> perfectly, providing precisely the information they want, no more and +> no less. Indeed, individual hypertexts and Web sites may contain +> sections that tend toward each extreme. -#+BEGIN_QUOTE -Often, however, designers should strive for the comfort, interest, and -habitability of parks and gardens: places that invite visitors to remain, and -that are designed to engage and delight them, to invite them to linger, to -explore, and to reflect. -#+END_QUOTE +> Often, however, designers should strive for the comfort, interest, and +> habitability of parks and gardens: places that invite visitors to +> remain, and that are designed to engage and delight them, to invite +> them to linger, to explore, and to reflect. -[[https://www.eastgate.com/garden/][Hypertext Garden]] +[Hypertext Garden](https://www.eastgate.com/garden/) -* Git +# Git -I want to get rid of all local modifications and go back to the working tree -of the most recent commit: +I want to get rid of all local modifications and go back to the working +tree of the most recent commit: -#+BEGIN_SRC sh +```sh git restore . -#+END_SRC +``` Revert a specified commit: -#+BEGIN_SRC sh +```sh git revert commit-id -#+END_SRC +``` Reset the repository to a specific commit in the git log: -#+BEGIN_SRC sh +```sh git reset --mixed commit-id -#+END_SRC +``` -I need to commit and push changes to a remote that has been changed since my -most recent pull: +I need to commit and push changes to a remote that has been changed +since my most recent pull: -#+BEGIN_SRC sh +```sh git pull --rebase -#+END_SRC +``` -* Hardware +# Hardware -** Laptops +## Laptops + +### macOS -*** macOS | Category | Details | +| -------- | --------------- | | Model | Macbook Pro 16" | | CPU | Apple M2 Pro | | RAM | 16GB | | Storage | 512GB SSD | -*** Linux +### Linux | Category | Details | -|----------|---------------------------------------------| +| -------- | ------------------------------------------- | | Model | Lenovo ThinkPad E15 Gen 4, model 21ED0048US | | CPU | AMD Ryzen 5 5625U with Radeon Graphics | | RAM | 16 GB | | Storage | 256 GB SSD | -** Servers +## Servers | Category | Details | -|--------------------|----------------------------------------| +| ------------------ | -------------------------------------- | | Case | Rosewill RSV-R4100U 4U | | Motherboard | NZXT B550 | | CPU | AMD Ryzen 7 5700G with Radeon Graphics | @@ -82,7 +83,7 @@ git pull --rebase | Storage (HDD Bay) | 48TB HDD | | PSU | Corsair RM850 PSU | -** Networking Equipment +## Networking Equipment - UDM-Pro - USW-24-PoE @@ -94,18 +95,18 @@ git pull --rebase - UVC G4 Doorbell Pro - UP Chime - USW 24-Port Patch Panel -- USW Switch Lite 8 PoE +- USW Switch Lite 8 PoE -* Software +# Software -** Laptop +## Laptop Alpine 3.18.2; no DE. -I currently run my Alpine laptop via the default login shell - no desktop -environment. From here, I use a mix of byobu and emacs to split my screen into -tabs and panes. All programs run through the shell and do not use visual -libraries such as X or Wayland. +I currently run my Alpine laptop via the default login shell - no +desktop environment. From here, I use a mix of byobu and emacs to split +my screen into tabs and panes. All programs run through the shell and do +not use visual libraries such as X or Wayland. I have Sway installed and configured, but only launch it when I must. @@ -128,17 +129,14 @@ I have Sway installed and configured, but only launch it when I must. - zola - zsh -** Server +## Server Ubuntu 22.04.1; no DE. -See my services page for a list of the publicly-available services running on -this server. +See my services page for a list of the publicly-available services +running on this server. - certbot - [docker, docker-compose] - nginx - zsh - - - diff --git a/elisp/ox-rss.el b/elisp/ox-rss.el deleted file mode 100644 index df7aeb6..0000000 --- a/elisp/ox-rss.el +++ /dev/null @@ -1,434 +0,0 @@ -;;; ox-rss.el --- RSS 2.0 Back-End for Org Export Engine - -;; Copyright (C) 2013-2021 Free Software Foundation, Inc. - -;; Author: Bastien Guerry <bzg@gnu.org> -;; Maintainer: Benedict Wang <foss@bhw.name> -;; Version: 0.0.1 -;; Package-Requires: ((emacs "26.1") (org "9.3")) -;; Keywords: org, wp, blog, feed, rss -;; Homepage: https://github.com/benedicthw/ox-rss.git - -;; This file is not part of GNU Emacs. - -;; This program is free software: you can redistribute it and/or modify -;; it under the terms of the GNU General Public License as published by -;; the Free Software Foundation, either version 3 of the License, or -;; (at your option) any later version. - -;; This program is distributed in the hope that it will be useful, -;; but WITHOUT ANY WARRANTY; without even the implied warranty of -;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -;; GNU General Public License for more details. - -;; You should have received a copy of the GNU General Public License -;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. - -;;; Commentary: - -;; This library implements an RSS 2.0 back-end for Org exporter, based -;; on the `html' back-end. -;; -;; It requires Emacs 24.1 at least. -;; -;; It provides two commands for export, depending on the desired output: -;; `org-rss-export-as-rss' (temporary buffer) and `org-rss-export-to-rss' -;; (as a ".xml" file). -;; -;; This backend understands three new option keywords: -;; -;; #+RSS_EXTENSION: xml -;; #+RSS_IMAGE_URL: https://myblog.org/mypicture.jpg -;; #+RSS_FEED_URL: https://myblog.org/feeds/blog.xml -;; -;; It uses #+HTML_LINK_HOME: to set the base url of the feed. -;; -;; Exporting an Org file to RSS modifies each top-level entry by adding a -;; PUBDATE property. If `org-rss-use-entry-url-as-guid', it will also add -;; an ID property, later used as the guid for the feed's item. -;; -;; The top-level headline is used as the title of each RSS item unless -;; an RSS_TITLE property is set on the headline. -;; -;; You typically want to use it within a publishing project like this: -;; -;; (add-to-list -;; 'org-publish-project-alist -;; '("homepage_rss" -;; :base-directory "~/myhomepage/" -;; :base-extension "org" -;; :rss-image-url "http://lumiere.ens.fr/~guerry/images/faces/15.png" -;; :html-link-home "http://lumiere.ens.fr/~guerry/" -;; :html-link-use-abs-url t -;; :rss-extension "xml" -;; :publishing-directory "/home/guerry/public_html/" -;; :publishing-function (org-rss-publish-to-rss) -;; :section-numbers nil -;; :exclude ".*" ;; To exclude all files... -;; :include ("index.org") ;; ... except index.org. -;; :table-of-contents nil)) -;; -;; ... then rsync /home/guerry/public_html/ with your server. -;; -;; By default, the permalink for a blog entry points to the headline. -;; You can specify a different one by using the :RSS_PERMALINK: -;; property within an entry. - -;;; Code: - -(require 'ox-html) -(declare-function url-encode-url "url-util" (url)) - -;;; Variables and options - -(defgroup org-export-rss nil - "Options specific to RSS export back-end." - :tag "Org RSS" - :group 'org-export - :version "24.4" - :package-version '(Org . "8.0")) - -(defcustom org-rss-image-url "https://orgmode.org/img/org-mode-unicorn-logo.png" - "The URL of the image for the RSS feed." - :group 'org-export-rss - :type 'string) - -(defcustom org-rss-extension "xml" - "File extension for the RSS 2.0 feed." - :group 'org-export-rss - :type 'string) - -(defcustom org-rss-categories 'from-tags - "Where to extract items category information from. -The default is to extract categories from the tags of the -headlines. When set to another value, extract the category -from the :CATEGORY: property of the entry." - :group 'org-export-rss - :type '(choice - (const :tag "From tags" from-tags) - (const :tag "From the category property" from-category))) - -(defcustom org-rss-use-entry-url-as-guid t - "Use the URL for the <guid> metatag? -When nil, Org will create ids using `org-icalendar-create-uid'." - :group 'org-export-rss - :type 'boolean) - -;;; Define backend - -(org-export-define-derived-backend 'rss 'html - :menu-entry - '(?r "Export to RSS" - ((?R "As RSS buffer" - (lambda (a s v b) (org-rss-export-as-rss a s v))) - (?r "As RSS file" (lambda (a s v b) (org-rss-export-to-rss a s v))) - (?o "As RSS file and open" - (lambda (a s v b) - (if a (org-rss-export-to-rss t s v) - (org-open-file (org-rss-export-to-rss nil s v))))))) - :options-alist - '((:description "DESCRIPTION" nil nil newline) - (:keywords "KEYWORDS" nil nil space) - (:with-toc nil nil nil) ;; Never include HTML's toc - (:rss-extension "RSS_EXTENSION" nil org-rss-extension) - (:rss-image-url "RSS_IMAGE_URL" nil org-rss-image-url) - (:rss-feed-url "RSS_FEED_URL" nil nil t) - (:rss-categories nil nil org-rss-categories)) - :filters-alist '((:filter-final-output . org-rss-final-function)) - :translate-alist '((headline . org-rss-headline) - (comment . (lambda (&rest args) "")) - (comment-block . (lambda (&rest args) "")) - (timestamp . (lambda (&rest args) "")) - (plain-text . org-rss-plain-text) - (section . org-rss-section) - (template . org-rss-template))) - -;;; Export functions - -;;;###autoload -(defun org-rss-export-as-rss (&optional async subtreep visible-only) - "Export current buffer to an RSS buffer. - -If narrowing is active in the current buffer, only export its -narrowed part. - -If a region is active, export that region. - -A non-nil optional argument ASYNC means the process should happen -asynchronously. The resulting buffer should be accessible -through the `org-export-stack' interface. - -When optional argument SUBTREEP is non-nil, export the sub-tree -at point, extracting information from the headline properties -first. - -When optional argument VISIBLE-ONLY is non-nil, don't export -contents of hidden elements. - -Export is done in a buffer named \"*Org RSS Export*\", which will -be displayed when `org-export-show-temporary-export-buffer' is -non-nil." - (interactive) - (let ((file (buffer-file-name (buffer-base-buffer)))) - (org-icalendar-create-uid file 'warn-user) - (org-rss-add-pubdate-property)) - (org-export-to-buffer 'rss "*Org RSS Export*" - async subtreep visible-only nil nil (lambda () (text-mode)))) - -;;;###autoload -(defun org-rss-export-to-rss (&optional async subtreep visible-only) - "Export current buffer to an RSS file. - -If narrowing is active in the current buffer, only export its -narrowed part. - -If a region is active, export that region. - -A non-nil optional argument ASYNC means the process should happen -asynchronously. The resulting file should be accessible through -the `org-export-stack' interface. - -When optional argument SUBTREEP is non-nil, export the sub-tree -at point, extracting information from the headline properties -first. - -When optional argument VISIBLE-ONLY is non-nil, don't export -contents of hidden elements. - -Return output file's name." - (interactive) - (let ((file (buffer-file-name (buffer-base-buffer)))) - (org-icalendar-create-uid file 'warn-user) - (org-rss-add-pubdate-property)) - (let ((outfile (org-export-output-file-name - (concat "." org-rss-extension) subtreep))) - (org-export-to-file 'rss outfile async subtreep visible-only))) - -;;;###autoload -(defun org-rss-publish-to-rss (plist filename pub-dir) - "Publish an org file to RSS. - -FILENAME is the filename of the Org file to be published. PLIST -is the property list for the given project. PUB-DIR is the -publishing directory. - -Return output file name." - (let ((bf (get-file-buffer filename))) - (if bf - (with-current-buffer bf - (org-icalendar-create-uid filename 'warn-user) - (org-rss-add-pubdate-property) - (write-file filename)) - (find-file filename) - (org-icalendar-create-uid filename 'warn-user) - (org-rss-add-pubdate-property) - (write-file filename) (kill-buffer))) - (org-publish-org-to - 'rss filename (concat "." org-rss-extension) plist pub-dir)) - -;;; Main transcoding functions - -(defun org-rss-headline (headline contents info) - "Transcode HEADLINE element into RSS format. -CONTENTS is the headline contents. INFO is a plist used as a -communication channel." - (if (> (org-export-get-relative-level headline info) 1) - (org-export-data-with-backend headline 'html info) - (unless (org-element-property :footnote-section-p headline) - (let* ((email (org-export-data (plist-get info :email) info)) - (author (and (plist-get info :with-author) - (let ((auth (plist-get info :author))) - (and auth (org-export-data auth info))))) - (htmlext (plist-get info :html-extension)) - (hl-number (org-export-get-headline-number headline info)) - (hl-home (file-name-as-directory (plist-get info :html-link-home))) - (hl-pdir (plist-get info :publishing-directory)) - (hl-perm (org-element-property :RSS_PERMALINK headline)) - (anchor - (or (org-element-property :CUSTOM_ID headline) - (org-export-get-reference headline info))) - (category (org-rss-plain-text - (or (org-element-property :CATEGORY headline) "") info)) - (pubdate0 (org-element-property :PUBDATE headline)) - (pubdate (let ((system-time-locale "C")) - (if (and pubdate0 (not (string-empty-p pubdate0))) - (format-time-string - "%a, %d %b %Y %T %z" - (org-time-string-to-time pubdate0))))) - (title (org-rss-plain-text - (or (org-element-property :RSS_TITLE headline) - (replace-regexp-in-string - org-link-bracket-re - (lambda (m) (or (match-string 3 m) - (match-string 1 m))) - (org-element-property :raw-value headline))) info)) - (publink - (or (and hl-perm (concat (or hl-home hl-pdir) hl-perm)) - (concat - (or hl-home hl-pdir) - (file-name-nondirectory - (file-name-sans-extension - (plist-get info :input-file))) "." htmlext "#" anchor))) - (guid (if org-rss-use-entry-url-as-guid - publink - (org-rss-plain-text - (or (org-element-property :ID headline) - (org-element-property :CUSTOM_ID headline) - publink) - info)))) - (if (not pubdate) "" ;; Skip entries with no PUBDATE prop - (format - (concat - "<item>\n" - "<title>%s</title>\n" - "<link>%s</link>\n" - "<author>%s (%s)</author>\n" - "<guid isPermaLink=\"false\">%s</guid>\n" - "<pubDate>%s</pubDate>\n" - (org-rss-build-categories headline info) "\n" - "<description><![CDATA[%s]]></description>\n" - "</item>\n") - title publink email author guid pubdate contents)))))) - -(defun org-rss-build-categories (headline info) - "Build categories for the RSS item from INFO. -Fallback to the HEADLINE :CATEGORY property." - (if (eq (plist-get info :rss-categories) 'from-tags) - (mapconcat - (lambda (c) (format "<category><![CDATA[%s]]></category>" c)) - (org-element-property :tags headline) - "\n") - (let ((c (org-element-property :CATEGORY headline))) - (format "<category><![CDATA[%s]]></category>" c)))) - -(defun org-rss-template (contents info) - "Return complete document string after RSS conversion. -CONTENTS is the transcoded contents string. INFO is a plist used -as a communication channel." - (let ((style (plist-get info :rss-stylesheet))) - (concat - (format "<?xml version=\"1.0\" encoding=\"%s\"?>" - (symbol-name org-html-coding-system)) - (if style - (format "\n<?xml-stylesheet type=\"text/xsl\" href=\"%s\"?>" - style)) - "\n<rss version=\"2.0\" - xmlns:content=\"http://purl.org/rss/1.0/modules/content/\" - xmlns:wfw=\"http://wellformedweb.org/CommentAPI/\" - xmlns:dc=\"http://purl.org/dc/elements/1.1/\" - xmlns:atom=\"http://www.w3.org/2005/Atom\" - xmlns:sy=\"http://purl.org/rss/1.0/modules/syndication/\" - xmlns:slash=\"http://purl.org/rss/1.0/modules/slash/\" - xmlns:georss=\"http://www.georss.org/georss\" - xmlns:geo=\"http://www.w3.org/2003/01/geo/wgs84_pos#\" - xmlns:media=\"http://search.yahoo.com/mrss/\">" - "<channel>" - (org-rss-build-channel-info info) "\n" - contents - "</channel>\n" - "</rss>"))) - -(defun org-rss-build-channel-info (info) - "Given plist INFO build the RSS channel information." - (let* ((system-time-locale "C") - (title (org-export-data (plist-get info :title) info)) - (email (org-export-data (plist-get info :email) info)) - (author (and (plist-get info :with-author) - (let ((auth (plist-get info :author))) - (and auth (org-export-data auth info))))) - (date (format-time-string "%a, %d %b %Y %T %z")) ;; RFC 882 - (description (org-export-data (plist-get info :description) info)) - (lang (plist-get info :language)) - (keywords (plist-get info :keywords)) - (rssext (plist-get info :rss-extension)) - (blogurl (or (plist-get info :html-link-home) - (plist-get info :publishing-directory))) - (image (url-encode-url (plist-get info :rss-image-url))) - (ifile (plist-get info :input-file)) - (publink - (or (plist-get info :rss-feed-url) - (concat (file-name-as-directory blogurl) - (file-name-nondirectory - (file-name-sans-extension ifile)) - "." rssext)))) - (format - "\n<title>%s</title> -<atom:link href=\"%s\" rel=\"self\" type=\"application/rss+xml\" /> -<link>%s</link> -<description><![CDATA[%s]]></description> -<language>%s</language> -<pubDate>%s</pubDate> -<lastBuildDate>%s</lastBuildDate> -<generator>%s</generator> -<webMaster>%s (%s)</webMaster> -<image> -<url>%s</url> -<title>%s</title> -<link>%s</link> -</image> -" - title publink blogurl description lang date date - (concat (format "Emacs %d.%d" - emacs-major-version - emacs-minor-version) - " Org-mode " (org-version)) - email author image title blogurl))) - -(defun org-rss-section (section contents info) - "Transcode SECTION element into RSS format. -CONTENTS is the section contents. INFO is a plist used as -a communication channel." - contents) - -(defun org-rss-timestamp (timestamp contents info) - "Transcode a TIMESTAMP object from Org to RSS. -CONTENTS is nil. INFO is a plist holding contextual -information." - (org-html-encode-plain-text - (org-timestamp-translate timestamp))) - -(defun org-rss-plain-text (contents info) - "Convert plain text CONTENTS into RSS encoded text. -INFO is a plist used as a communication channel" - (let (output) - (setq output (org-html-encode-plain-text contents) - output (org-export-activate-smart-quotes - output :html info)))) - -;;; Filters - -(defun org-rss-final-function (contents backend info) - "Prettify the RSS output. -CONTENTS is the headline contents as a transcoded string. BACKEND -is a symbol representation of the backend used. INFO is a plist -used as a communication channel." - (with-temp-buffer - (xml-mode) - (insert contents) - (indent-region (point-min) (point-max)) - (buffer-substring-no-properties (point-min) (point-max)))) - -;;; Miscellaneous - -(defun org-rss-add-pubdate-property () - "Set the PUBDATE property for top-level headlines." - (let (msg) - (org-map-entries - (lambda () - (let* ((entry (org-element-at-point)) - (level (org-element-property :level entry))) - (when (= level 1) - (unless (org-entry-get (point) "PUBDATE") - (setq msg t) - (org-set-property - "PUBDATE" (format-time-string - (cdr org-time-stamp-formats))))))) - nil nil 'comment 'archive) - (when msg - (message "Property PUBDATE added to top-level entries in %s" - (buffer-file-name)) - (sit-for 2)))) - -(provide 'ox-rss) - -;;; ox-rss.el ends here diff --git a/elisp/publish.el b/elisp/publish.el deleted file mode 100644 index 72767dc..0000000 --- a/elisp/publish.el +++ /dev/null @@ -1,59 +0,0 @@ -;; Publish org files to HTML - -;; Functions -(defun org-rss-publish-to-rss (plist filename pub-dir) - "Publish RSS with PLIST, only when FILENAME is 'rss.org'. -PUB-DIR is when the output will be placed." - (if (equal "rss.org" (file-name-nondirectory filename)) - (org-rss-export-to-rss plist filename pub-dir))) - -;; Project publishing settings -(setq org-publish-project-alist - '(("cleberg.net" - :base-directory "~/Source/cleberg.net/" - :publishing-function org-html-publish-to-html - :publishing-directory "~/Source/cleberg.net/public/" - :auto-sitemap t - :recursive t - :section-numbers nil - :with-author nil - :html-validation-link nil - :with-tags t - :html-htmlize-output-type 'inline-css - :html-head-include-default-style nil - :html-head-include-scripts nil - :html-head "<link rel=stylesheet href=/static/styles.min.css>" - :html-preamble "<nav><a href=/>Home</a><a href=/blog/>Blog</a><a href=/services/>Services</a><a href=/wiki/>Wiki</a></nav>") - - ("rss" - :base-directory "~/Source/cleberg.net/blog/" - :base-extension "org" - :html-link-home "https://cleberg.net/" - :html-link-use-abs-url t - :rss-extension "xml" - :publishing-directory "~/Source/cleberg.net/public/blog/" - :publishing-function org-rss-publish-to-rss - :section-numbers nil - :exclude "index.org" - :author "cmc" - :email "" - ;; test - :html-link-org-files-as-html t - :auto-sitemap t - :sitemap-filename "rss.org" - :sitemap-title "cleberg.net" - :sitemap-style list - :sitemap-sort-files anti-chronologically - ;;:sitemap-function 'rw/format-rss-feed - ;;:sitemap-format-entry 'rw/format-rss-feed-entry - ;; end test - ) - - ("static" - :base-directory "~/Source/cleberg.net/static/" - :base-extension "css\\|txt" - :publishing-directory "~/Source/cleberg.net/public/static/" - :publishing-function org-publish-attachment) - ("website" :components ("cleberg.net" "rss" "static")))) - -(provide 'publish) diff --git a/index.org b/index.org deleted file mode 100644 index 25f096c..0000000 --- a/index.org +++ /dev/null @@ -1,26 +0,0 @@ -#+title: cleberg.net -#+OPTIONS: toc:nil - -#+BEGIN_QUOTE -Do AIs dream in electric sheep? - -He hoped it had nanosecond nightmares. -#+END_QUOTE - -** Pages -:PROPERTIES: -:ID: A3B9560A-66B5-4526-ACA3-BA766C75CDDE -:END: - -- [[./blog/][Blog]] -- [[./services/][Services]] -- [[./wiki/][Wiki]] - -** Contact -:PROPERTIES: -:ID: A0D2C73E-264F-4DBC-BF87-E875EA36D6A5 -:END: - -- hello [at] cleberg.net ([[./static/gpg.txt][GPG]]) -- [[https://matrix.to/#/@cyborg:matrix.tchncs.de][@cyborg@matrix.tchncs.de]] -- [[https://git.cleberg.net][Source Code]] diff --git a/salary/index.org b/salary/index.org deleted file mode 100644 index 9828b1e..0000000 --- a/salary/index.org +++ /dev/null @@ -1,53 +0,0 @@ -#+title: Salary -#+date: 2023-10-01 - -* Salary Transparency - -The data below details the base salary information for each job I've held. This -information is posted publicly to ensure others in my position have a solid -reference point when determining if their current or proposed salary is -appropriate. - -While sites like Glassdoor are locking salary data behind a paywall, LinkedIn is -discontinuing LinkedIn Salary, and helpful websites like Big 4 Transparency are -extremely rare, I wanted to provide my personal data publicly and freely to -those who need it. - -I have seen what can happen when great employees don't know the market values -for their skills and I happily help those in my teams, so I'm happy to extend -this information to the online community. - -As a final note, there are numerous reasons that people in the same role are -paid differently (expertise, years of experience, certifications, education, -etc.) and that the data in this table should only be used as a single point of -reference, not the whole story. - -* Salary Data - -Note: When in a role that gives periodic raises, I will create a new record with -the new base salary in the table below. See the KPMG records for an example of a -raise while in the same role. - -| Title | Company | Location | Start Date | End Date | Base Salary | -|---------------------------------------+------------------------+----------------+------------+----------+-------------| -| Senior Technology Assurance Associate | KPMG | Omaha, NE | 2023-10 | Current | $116,700 | -| Senior Technology Assurance Associate | KPMG | Omaha, NE | 2022-06 | 2023-10 | $110,000 | -| Senior Technology Risk Consultant | Ernst & Young | Des Moines, IA | 2021-09 | 2022-06 | $89,500 | -| Senior IT Auditor | Ameritas | Lincoln, NE | 2021-05 | 2021-09 | $72,000 | -| IT Auditor | Ameritas | Lincoln, NE | 2020-04 | 2021-05 | $65,000 | -| IS Auditor II | Nelnet | Lincoln, NE | 2019-12 | 2020-04 | $58,000 | -| IS Auditor I | Nelnet | Lincoln, NE | 2019-06 | 2019-12 | $20/hour | -| Internal Audit Intern | Ameritas | Lincoln, NE | 2018-02 | 2019-06 | $16/hour | -| Teaching Assistant | University of Nebraska | Lincoln, NE | 2017-08 | 2018-05 | $7/hour | -| Community Management Intern | Walgreens | Lincoln, NE | 2017-06 | 2018-02 | $14/hour | - -This page was inspired by [[https://xeiaso.net/][Xe]], and I'm quoting the following wording from them as -I want to reiterate this piece: - -#+BEGIN_QUOTE -Please consider publishing your salary data like this as well. By open, -voluntary transparency we can help to end stigmas around discussing pay and help -ensure that the next generations of people in tech are treated fairly. Stigmas -thrive in darkness but die in the light of day. You can help end the stigma by -playing your cards out in the open like this. -#+END_QUOTE diff --git a/services/index.org b/services/index.org deleted file mode 100644 index be5e0eb..0000000 --- a/services/index.org +++ /dev/null @@ -1,16 +0,0 @@ -#+title: Services -#+OPTIONS: toc:nil - -- [[https://ao.cleberg.net][AnonymousOverflow]] - A StackOverflow proxy -- [[https://cyberchef.cleberg.net][CyberChef]] - The Cyber Swiss Army Knife -- [[https://files.cleberg.net][FileArchive]] - An interesting file archive -- [[https://paste.cleberg.net][FlashPaper]] - One-time encrypted password/secret sharing -- [[https://gh.cleberg.net][GotHub]] - An alternative front-end for GitHub -- [[https://ip.cleberg.net][ifconfig.php]] - A "whatsmyip" tool -- [[https://invidious.cleberg.net][Invidious]] - A YouTube proxy -- [[https://nitter.cleberg.net][Nitter]] - A Twitter proxy -- [[https://office.cleberg.net][Office]] - The world's smallest office suite -- [[https://search.cleberg.net][SearXNG]] - A privacy-respecting, open metasearch engine - -See the [[https://git.cleberg.net/?p=cleberg.net.git;a=history;f=services/index.org;h=71ed6bcae7e52a8103f980f1821ca291ef3010ba;hb=HEAD][git log]] for this page if you want to see changes that have been made. - diff --git a/static/styles.css b/static/styles.css index c2807dd..4a14cb4 100644 --- a/static/styles.css +++ b/static/styles.css @@ -1,3 +1,365 @@ +/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */ + +/* Document + ========================================================================== */ + +/** + * 1. Correct the line height in all browsers. + * 2. Prevent adjustments of font size after orientation changes in iOS. + */ + + html { + line-height: 1.15; /* 1 */ + -webkit-text-size-adjust: 100%; /* 2 */ + } + + /* Sections + ========================================================================== */ + + /** + * Remove the margin in all browsers. + */ + + body { + margin: 0; + } + + /** + * Render the `main` element consistently in IE. + */ + + main { + display: block; + } + + /** + * Correct the font size and margin on `h1` elements within `section` and + * `article` contexts in Chrome, Firefox, and Safari. + */ + + h1 { + font-size: 2em; + margin: 0.67em 0; + } + + /* Grouping content + ========================================================================== */ + + /** + * 1. Add the correct box sizing in Firefox. + * 2. Show the overflow in Edge and IE. + */ + + hr { + box-sizing: content-box; /* 1 */ + height: 0; /* 1 */ + overflow: visible; /* 2 */ + } + + /** + * 1. Correct the inheritance and scaling of font size in all browsers. + * 2. Correct the odd `em` font sizing in all browsers. + */ + + pre { + font-family: monospace, monospace; /* 1 */ + font-size: 1em; /* 2 */ + } + + /* Text-level semantics + ========================================================================== */ + + /** + * Remove the gray background on active links in IE 10. + */ + + a { + background-color: transparent; + } + + /** + * 1. Remove the bottom border in Chrome 57- + * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari. + */ + + abbr[title] { + border-bottom: none; /* 1 */ + text-decoration: underline; /* 2 */ + text-decoration: underline dotted; /* 2 */ + } + + /** + * Add the correct font weight in Chrome, Edge, and Safari. + */ + + b, + strong { + font-weight: bolder; + } + + /** + * 1. Correct the inheritance and scaling of font size in all browsers. + * 2. Correct the odd `em` font sizing in all browsers. + */ + + code, + kbd, + samp { + font-family: monospace, monospace; /* 1 */ + font-size: 1em; /* 2 */ + } + + /** + * Add the correct font size in all browsers. + */ + + small { + font-size: 80%; + } + + /** + * Prevent `sub` and `sup` elements from affecting the line height in + * all browsers. + */ + + sub, + sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; + } + + sub { + bottom: -0.25em; + } + + sup { + top: -0.5em; + } + + /* Embedded content + ========================================================================== */ + + /** + * Remove the border on images inside links in IE 10. + */ + + img { + border-style: none; + } + + /* Forms + ========================================================================== */ + + /** + * 1. Change the font styles in all browsers. + * 2. Remove the margin in Firefox and Safari. + */ + + button, + input, + optgroup, + select, + textarea { + font-family: inherit; /* 1 */ + font-size: 100%; /* 1 */ + line-height: 1.15; /* 1 */ + margin: 0; /* 2 */ + } + + /** + * Show the overflow in IE. + * 1. Show the overflow in Edge. + */ + + button, + input { /* 1 */ + overflow: visible; + } + + /** + * Remove the inheritance of text transform in Edge, Firefox, and IE. + * 1. Remove the inheritance of text transform in Firefox. + */ + + button, + select { /* 1 */ + text-transform: none; + } + + /** + * Correct the inability to style clickable types in iOS and Safari. + */ + + button, + [type="button"], + [type="reset"], + [type="submit"] { + -webkit-appearance: button; + } + + /** + * Remove the inner border and padding in Firefox. + */ + + button::-moz-focus-inner, + [type="button"]::-moz-focus-inner, + [type="reset"]::-moz-focus-inner, + [type="submit"]::-moz-focus-inner { + border-style: none; + padding: 0; + } + + /** + * Restore the focus styles unset by the previous rule. + */ + + button:-moz-focusring, + [type="button"]:-moz-focusring, + [type="reset"]:-moz-focusring, + [type="submit"]:-moz-focusring { + outline: 1px dotted ButtonText; + } + + /** + * Correct the padding in Firefox. + */ + + fieldset { + padding: 0.35em 0.75em 0.625em; + } + + /** + * 1. Correct the text wrapping in Edge and IE. + * 2. Correct the color inheritance from `fieldset` elements in IE. + * 3. Remove the padding so developers are not caught out when they zero out + * `fieldset` elements in all browsers. + */ + + legend { + box-sizing: border-box; /* 1 */ + color: inherit; /* 2 */ + display: table; /* 1 */ + max-width: 100%; /* 1 */ + padding: 0; /* 3 */ + white-space: normal; /* 1 */ + } + + /** + * Add the correct vertical alignment in Chrome, Firefox, and Opera. + */ + + progress { + vertical-align: baseline; + } + + /** + * Remove the default vertical scrollbar in IE 10+. + */ + + textarea { + overflow: auto; + } + + /** + * 1. Add the correct box sizing in IE 10. + * 2. Remove the padding in IE 10. + */ + + [type="checkbox"], + [type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ + } + + /** + * Correct the cursor style of increment and decrement buttons in Chrome. + */ + + [type="number"]::-webkit-inner-spin-button, + [type="number"]::-webkit-outer-spin-button { + height: auto; + } + + /** + * 1. Correct the odd appearance in Chrome and Safari. + * 2. Correct the outline style in Safari. + */ + + [type="search"] { + -webkit-appearance: textfield; /* 1 */ + outline-offset: -2px; /* 2 */ + } + + /** + * Remove the inner padding in Chrome and Safari on macOS. + */ + + [type="search"]::-webkit-search-decoration { + -webkit-appearance: none; + } + + /** + * 1. Correct the inability to style clickable types in iOS and Safari. + * 2. Change font properties to `inherit` in Safari. + */ + + ::-webkit-file-upload-button { + -webkit-appearance: button; /* 1 */ + font: inherit; /* 2 */ + } + + /* Interactive + ========================================================================== */ + + /* + * Add the correct display in Edge, IE 10+, and Firefox. + */ + + details { + display: block; + } + + /* + * Add the correct display in all browsers. + */ + + summary { + display: list-item; + } + + /* Misc + ========================================================================== */ + + /** + * Add the correct display in IE 10+. + */ + + template { + display: none; + } + + /** + * Add the correct display in IE 10. + */ + + [hidden] { + display: none; + } + + +/* CUSTOM CSS */ +:root { + --bg: #181a1b; + --bg-bright: #2f3132; + --fg: #c6c6c6; + --fg-bright: #fff; + --fg-dark: #575757; + --blue: #6eb6ff; + --pink: #ff91a5; +} + @media (prefers-reduced-motion: no-preference) { :root { scroll-behavior: smooth; @@ -5,9 +367,9 @@ } body { - background-color: #282828; - color: #ebdbb2; - font-family: Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace; + background-color: var(--bg); + color: var(--fg); + font-family: -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif; font-size: 1rem; line-height: 1.5; max-width: 45em; @@ -15,65 +377,51 @@ body { padding: 0 1rem; } -nav, +.site-nav, footer { - border-color: #ebdbb2; + border-color: var(--fg); } -h1 { - color: #458588; -} - -h2 { - color: #d79921; -} - -h3 { - color: #b16286; +footer { + border-top: 1px dotted; + padding-top: 1rem; + margin: 1rem 0; } -h4 { - color: #cc241d; +footer p { + margin: 0; } -h1::before { - content: "* "; +.site-nav { + border-bottom: 1px dotted; } -h2::before { - content: "** "; +.site-nav ul { + list-style-type: none; + display: flex; + align-items: center; + padding: 0; } -h3::before { - content: "*** "; +.site-nav ul li { + margin-right: 0.5rem; } -h4::before { - content: "**** "; +h1, +h2, +h3, +h4 { + color: var(--fg-bright); } a, a:visited { - color: #689d6a; - text-decoration: underline; + color: var(--blue); + text-decoration: none; } a:hover { - background-color: #689d6a; - color: #282828; -} - -#preamble { - padding: 1rem 0; -} - -#preamble nav a { - margin-right: 0.5rem; -} - -#postamble { - border-top: 1px solid #000; - margin-top: 1rem; + text-decoration: underline; } img { @@ -82,15 +430,15 @@ img { table { border-collapse: collapse; - color: #ebdbb2; - border-color: #665c54; + color: var(--fg); + border-color: var(--fg-dark); } thead, th, tr, td { - border: 1px solid #665c54; + border: 1px solid var(--fg-dark); padding: 0.25rem; } @@ -102,56 +450,60 @@ code { } pre { - background-color: #3c3836; + background-color: var(--bg-bright) !important; + border-radius: 3px; margin: 0.5rem 0; + padding: 0.5rem; overflow-x: auto; } -pre::before, -pre::after { - background-color: #504945; - display: block; - white-space: pre; -} - -pre::before { - content: "#+BEGIN_SRC"; -} - -pre::after { - content: "#+END_SRC"; -} - :not(pre) > code { - color: #d79921; + background-color: var(--bg-bright); + color: var(--pink); + padding: 0.15rem; + border-radius: 3px; } aside { - background-color: #504945; + background-color: var(--bg-bright); padding: 1rem; } blockquote { + background-color: var(--bg-bright); + border-left: 10px solid var(--blue); margin: 1rem 0; + padding: 0.5rem 1rem; } blockquote p { margin: 0; } -blockquote::before, -blockquote::after { - background-color: #504945; - display: block; - white-space: pre; +.post time { + margin-right: 0.5rem; +} + +.post-metadata { + border: 1px dotted var(--fg); + border-top: none; + padding: 1rem; +} + +.post-metadata h1 { + margin: 0; +} + +.post-metadata p { + margin: 0; } -blockquote::before { - content: "#+BEGIN_QUOTE"; +details { + margin-top: 1rem; } -blockquote::after { - content: "#+END_QUOTE"; +summary { + font-weight: bold; } .footnote-definition { diff --git a/templates/base.html b/templates/base.html new file mode 100644 index 0000000..59e8f5e --- /dev/null +++ b/templates/base.html @@ -0,0 +1,44 @@ +<!doctype html> +<html lang="en"> +<head> + <title>cleberg.net</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + {% if page %} + {% if page.description %} + <meta name="description" content="{{ page.description }}"> + {% elif config.description %} + <meta name="description" content="{{ config.description }}"> + {% endif %} + {% elif config.description %} + <meta name="description" content="{{ config.description }}" /> + {% endif %} + + {% block rss %} + <link rel="alternate" type="application/atom+xml" title="RSS" href="{{ get_url(path="atom.xml", trailing_slash=false) }}"> + {% endblock %} + + {% block css %} + <link rel="stylesheet" href="/styles.css"> + {% endblock css %} + + {% block extra_head %}{% endblock extra_head %} +</head> +<body> + <nav class="site-nav"> + <ul> + <li><a href="/">Home</a></li> + <li><a href="/blog/">Blog</a></li> + <li><a href="/services/">Services</a></li> + <li><a href="/wiki/">Wiki</a></li> + </ul> + </nav> + + <main>{% block content %}{% endblock content %}</main> + + <footer> + <p>Last build: {{ now() | date(format="%Y-%m-%d %H:%M:%S") }}</p> + <p><a href="https://git.sr.ht/~cyborg/cleberg.net" target="_blank" rel="noopener">Source Code</a></p> + <p><a href="/atom.xml">Atom RSS Feed</a></p> + </footer> +</body> +</html> diff --git a/templates/index.html b/templates/index.html new file mode 100644 index 0000000..ff4d20c --- /dev/null +++ b/templates/index.html @@ -0,0 +1,40 @@ +{% extends "base.html" %} + +{% block content %} +<section> + <h1>cleberg.net</h1> + <blockquote>Do AIs dream in electric sheep?<br>He hoped it had nanosecond nightmares.</blockquote> +</section> +<section> + <h2>Recent Blog Posts</h2> + {% set section = get_section(path="blog/_index.md") %} + {% set i = 0 %} + {% for page in section.pages %} + {% if i < 3%} + {% set_global i = i + 1%} + <div class="post"> + <time datetime="{{ page.date | date(format='%Y-%m-%d %H:%M:%S') }}">{{ page.date }}</time> + <a href="/blog/{{ page.slug }}/">{{ page.title }}</a> + </div> + {% endif %} + {% endfor %} + <br> + <a href="/blog/">Older Posts →</a> +</section> +<section> + <h2>Everything Else</h2> + <ul> + <li><a href="/salary/">Salary</a></li> + <li><a href="/services/">Services</a></li> + <li><a href="/wiki/">Wiki</a></li> + </ul> +</section> +<section> + <h2>Contact</h2> + <ul> + <li>hello [at] cleberg.net (<a href="/gpg.txt">GPG</a>)</li> + <li><a href="https://matrix.to/#/@cyborg:matrix.tchncs.de" target="_blank" rel="noopener">@cyborg:@matrix.tchncs.de</a></li> + <li><a href="https://git.sr.ht/~cyborg/" target="_blank" rel="noopener">Sourcehut</a></li> + </ul> +</section> +{% endblock content %} diff --git a/templates/page.html b/templates/page.html new file mode 100644 index 0000000..f668751 --- /dev/null +++ b/templates/page.html @@ -0,0 +1,41 @@ +{% extends "base.html" %} + +{% block css %} +<link rel="stylesheet" href="/syntax-theme-dark.css"> +<link rel="stylesheet" href="/styles.css"> +{% endblock css %} + +{% block content %} +<section class="post-metadata"> + <h1>{{ page.title }}</h1> + {% if page.date %} + <p><time datetime="{{ page.date | date(format='%Y-%m-%d %H:%M:%S') }}">{{ page.date }}</time></p> + {% endif %} + <p>{{ page.word_count }} words; {{ page.reading_time }} minute(s)</p> +{% if page.toc %} + <details open> + <summary>Table of Contents</summary> + <nav class="page-nav"> + <ul> + {% for h1 in page.toc %} + <li> + <a href="{{ h1.permalink | safe }}">{{ h1.title }}</a> + {% if h1.children %} + <ul> + {% for h2 in h1.children %} + <li> + <a href="{{ h2.permalink | safe }}">{{ h2.title }}</a> + </li> + {% endfor %} + </ul> + {% endif %} + </li> + {% endfor %} + </ul> + </nav> + </details> +{% endif %} +</section> + +{{ page.content | safe }} +{% endblock content %} diff --git a/templates/section.html b/templates/section.html new file mode 100644 index 0000000..70e8cb1 --- /dev/null +++ b/templates/section.html @@ -0,0 +1,18 @@ +{% extends "base.html" %} + +{% block content %} +<h1>{{ section.title }}</h1> +<p>Use <code>Ctrl + f</code> to search blog post titles for keywords. +<br>You can also add the <a href="/atom.xml">Atom RSS Feed</a> to your feed reader.</p> +{% set post_date = "1970-01-01" | date(format="%Y") %} +{% for page in section.pages %} + {% if post_date != page.date | date(format="%Y") %} + {% set_global post_date = page.date | date(format="%Y") %} + <h2>{{ post_date }}</h2> + {% endif %} + <div class="post"> + <time datetime="{{ page.date | date(format='%Y-%m-%d %H:%M:%S') }}">{{ page.date }}</time> + <a href="/blog/{{ page.slug }}/">{{ page.title }}</a> + </div> +{% endfor %} +{% endblock content %} |