aboutsummaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2023-12-21all: setup tour.awwan.orgShulhan
Now that the _tour is ready we can deploy it to tour.awwan.org. The website is updated to include link to tour domain. Implements: https://todo.sr.ht/~shulhan/awwan/4
2023-12-08_wui/doc: detach the index from READMEShulhan
The links in the index should be relative, so we can test and deploy it anywhere. Also the README contains link to website which is redundant if rendered on website itself.
2023-12-01all: fix link to Repository in the READMEShulhan
2023-10-29cmd/www-awwan: move command "embed" as part of internal buildShulhan
2023-10-29_www/doc: update todo and READMEShulhan
In todo we remove completed and unknown tasks which makes the current awwan implementation is feature complete in CLI perspective. While at it, fix missing index.css not included in internal memfs.
2023-10-22all: restructure the documentationShulhan
The index in "_www/doc" now become README in the root repository, while the README is moved to "_www/doc" as manual page of awwan.
2023-10-22all: document the magic word "#local"Shulhan
2023-10-21_www/doc: update manual page related to options in "#get" and "#put"Shulhan
The magic command "#get" and "#put" now have options to set the owner and permissions of destination file using the following syntax, GET = "#get" (":"/"!") [OWNER] ["+" PERM] SP REMOTE_PATH SP LOCAL_PATH PUT = "#put" (":"/"!") [OWNER] ["+" PERM] SP LOCAL_PATH SP REMOTE_PATH
2023-10-15internal/cmd/www-awwan: new static web server for awwan.orgShulhan
the www-awwan is static web server, built using ciigo, to serve the website at awwan.org.
2023-09-30all: add option to bypass input passphrase from terminalShulhan
In the environment where passphrase cannot be inputted manually, for example, automatic integration or deployment, we need some mechanism where awwan can be executed to copy or decrypt the encrypted file. The option is by reading plain passphrase from file named "awwan.pass" inside the ".ssh" directory. If its exists and not empty, awwan will not prompt for passphrase from terminal, instead use the content of that file as passhprase.
2023-09-29all: update README related to support for encryptionShulhan
While at it, also update the documentation index, remove finished TODO, add and expand items in TODO to be more descriptive.
2023-09-27all: change default path for private key to be located under .ssh directoryShulhan
Using hidden file (with "." prefix in name) cluttering the workspace directory. Since we already have ".ssh" as indicator of workspace, we should use it, the same principal that ~/.ssh/ store user's private key.
2023-09-20cmd/awwan: implement command to decrypt file using private keyShulhan
The "decrypt" command accept single argument, a file to be decrypted. Its reverse the "encrypt" output to get the plain text back.
2023-09-20cmd/awwan: implement command to encrypt fileShulhan
The encrypt command accept single argument, the file to be encrypted.
2023-05-14all: convert README from Asciidoc to MarkdownShulhan
I use two remote repositories: GitHub and SourceHut. GitHub support rendering README using asciidoc while SourceHut not. This cause the repository that use README.adoc rendered as text in SourceHut which make the repository page less readable. Also, the pkg.go.dev now render README but only support Markdown. Since we cannot control the SourceHut and go.dev, the only option is to support converting Markdown in ciigo so I can write README using Markdown and the rest of documentation using Asciidoc.
2023-05-14all: update module share and ciigo to latest versionShulhan
This changes replace share package lib/io with lib/os, since the former has been deprecated.
2022-07-30all: remove old README.mdShulhan
The original README is written in AsciiDoc. The reason we still keep the markdown one is because the sr.ht, where we host the repository, cannot render adoc file. To mitigate this, we create symlink README without extension to allow sr.ht render it as text.
2020-06-04all: add magic command "#require:"Shulhan
Magic word `#require:` will ensure that the next statement will always executed when its skipped with start number. For example, given following script with line number 1: #require: 2: echo a 3: echo b 4: #require: 5: echo c ``` executing `awwan local script.aww 3`, will always execute line number 2 `echo a`, but not line number 5 (because its before line start 3).
2020-05-31README: update an example sectionShulhan
Show where the file location using $WORKDIR and shell script syntax to generate here-document.
2020-05-30README.md: a copy of README.adoc for visibilityShulhan