Difference between revisions of "Personal Knowledge Container"

From PKC
Jump to navigation Jump to search
BenKoo>Admin
 
(222 intermediate revisions by 15 users not shown)
Line 1: Line 1:
=Personal Knowledge Container=
[[PKC|'''Personal''' Knowledge Container]]([[wikidata:Q110762241|Q110762241]])/([[個人知識容器]]) is a way to help attain personalized [[data sovereignty]] through [[Personal Cloud]] technologies. It can also be used as [[Public Knowledge Container|'''Public''' Knowledge Container]] and/or [[Project Knowledge Container|'''Project''' Knowledge Container]].It is abbreviated as [[PKC]]<ref>PKC (Github Project, URL: https://github.com/xlp0/PKC</ref><ref>{{:Video/Yochai Benkler: Open-source economics}}</ref><ref>Encyclosphere. (2022, April 6). PKC Media Wiki, . Retrieved 03:24, April 26, 2022 from https://www.pkc.pub/index.php?title=Encyclosphere&oldid=29070.</ref>, is a [[PKC services|collection of micro services (computation and communication processes)]] that enables personalized [[data is the asset|ownership]] of [[Hyperlink-centric data asset]]<ref>https://www.bmc.com/blogs/microservices-architecture/</ref>. It is a tool designed to be operated by individuals or communities of varying sizes and can be deployed to [[network environments]] of your choice. After the [[PKC#Installation_Procedure.2FImplementation_Process|installation]], your local instance of [[PKC]] service on [[your own computer]] will work, even without access to the [[wikipedia:Internet|Internet]]. [[PKC]] allows for an integrative deployment of [[user-friendly knowledge presentation]], [[extensible functionalities]], and [[self-servicing data asset ownership]] in a single package. In other words, this technology platform is designed to lower the entry barrier for the ownership of [[self-sovereign data asset]]s.
This project, [PersonalKnowledgeContainer], abbreviated as [PKC], provides an executable script ([up.sh]) that installs a MediaWiki-based docker-based [microservice] in a network environment of your choice. After the installation, it can operate on your own machine with or without Internet connection.


==Context==
=The abstract specification of PKC=
After [microservice] technologies become ubiquitous, it is possible to organize personal knowledge using a personally operated [MediaWiki] services that could work even the computer is not connect to the Internet. This **off-line** capability will enable anyone to enjoy the power of open source software without worrying your data might be leaked to the public. However, to make sure that your own data will always be accessible to you, users of this self-operated service must have a simple procedure to perform data backup and restoration, so that data may continue to work after one switch to a different computer. Moreover, individuals shoud also be able to read their own data even the software for displaying them hasevolved to a new version that doesn't work with data stored with previous versions. This project intend to resolve this challenge by giving everyone the choice to run their own chosen version of MediaWiki software, given that all the images that have proven to work has publicly available images, so that even if the software has been abandoned, one may use [container-virtualization] technologies to continue operate the software.
It will be helpful to read the [[Abstract Specification of PKC]] before continuing.


==Goal==
{{LogicModel
Create a basic set of services, files, and page content that help individuals to operate a MediaWiki website on any machines of their choosing, and allow them to continuously work with their own data set, independent of future changes.
|name=PKC
}}


==Success Criteria==
{{:PKC/Readme.md}}
1. Allow Individuals to install an instance of MediaWiki service by reading this REAME.md file.
2. Make all textual content, executable software images, installation scripts in the public domain, so that everyone can share and use them at will.
3. Provide instructions to learn about how to use [PKC] in the initial MediaWiki's database, so that people can start learning to use PKC through their own instance of MediaWiki.


==Implementation Process==
The following text shows the required resources and action items for [PKC] installation.


==Required Resources==
<noinclude>
1. A computer that you have access to its "root" or "administrator" previledge.
=Slide Show=
2. Operatng Systems that support [Docker]: Windows 10, Mac OS X Big Sur 11.2.3 and Linux.
For a slide show on [[PKC]], please see this following slide set:
3. Under Windows 10 Environment, some VPN software might interfere with [Docker]'s Windows Subsystem for Linux, a.k.a. [WSL], you will need to remove VPN software before installing [Docker]. In case you don't want to remvoe your VPN software, or your Docker and Bash have compatibility issues, please try to [VirtualBox PKC] solution.
<nowiki>{{#widget:Google Presentation|docid= 18ZArxRn0FuQPLcAIkXeNxOsZFyrnLR1ncdkqTm6TqVk |size=medium}}</nowiki>
4. Access to the Internet during intallation time. Please try to perform the installation on a network with 10Mbps+ to the Internet. After installation, this system can operated without access to the Internet.
{{#widget:Google Presentation|docid= 18ZArxRn0FuQPLcAIkXeNxOsZFyrnLR1ncdkqTm6TqVk |size=medium}}
 
{{PagePostfix
==Installation Procedure==
|category_csd=Personal Cloud,Personal Data Container,PKC,PKM, Data Science,Soulbound Token,Monoid
1. Install [Docker], the Installation instructions and downloadable files can be found here: https://docs.docker.com/get-started/
|semantic_labels=[[Page created by date::Start datetime]]= [[Start datetime::{{CURRENTMONTH}} {{CURRENTDAY}}, {{CURRENTYEAR}}]]
2. Go to a [command line], or so called [terminal] application, move your working directory using the command "**[cd]**" for **change directory**, to a directory in your file system that you keep your working files. For Mac OS X and Linux operating systems, Terminal applications are bundled during installation. For Windows 10, we recommend you to use [Git Bash], when you install [git] for Windows, [Git Bash] is included the installation process.
}}
 
</noinclude>
Assume the directory you keep your working files is called: **Workspace**. Your terminal application should have something like this:
 
```
<machine_name>:Workspace <user_name>$
```
 
Download the entire package using [git]. You may copy the instruction as follows:
 
```
<machine_name>:Workspace <user_name>$ git clone https://github.com/benkoo/PersonalKnowledgeContainer.git
```
 
3. After the [git clone] instruction copied relevant data to your working directory, using the command [cd] to the **PersonalKnolwedgeContainer** directory that contains the script ([up.sh]), and type: "./[up.sh]" to execute the script.
 
```
<machine_name>:Workspace <user_name>$ cd PersonalKnowledgeContainer
<machine_name>:PersonalKnowledgeContainer <user_name>$ ./up.sh
```
 
4. Open a browser: type the following URL to the browser's URL field: http://localhost:9352 or http://127.0.0.1:9352
5. Read the instructions in the [Main Page].
 
==Outcomes Expected==
1. Every 30 minutes, all the changes you made to this local instance of MediaWiki will be automatically backed up to the directory's "backup/" sub-directory.
2. The textual content stored in MediaWiki's database can will be stored in an XML file: XLPLATEST.xml
3. All the uploaded files, assuming the file names are accepted by the host operating system, will be dumped to the "backup/MediaFile/" sub-directory.
 
==Boundary Conditions==
1. We do not warrant any reliability, completeness, and accuracy of this installation procedure. **Any action you take upon this information and execute this script is at your own risk**, We will not be liable for any losses and damages in connection to the use of the actions and software prescribed here.
2. We have only tested on a small number of machines and configurations, your mileage may vary.
3. Do not remove any of the files in the directory with "*backup/*", such as "*docker-compose.yml*" and the "*LocalSettings.php*". These files are the configuration files for [Docker] and [MediaWiki] respectively. Missing them, this system will stops to work. 
4. For the sake of reducing typos, the project has moved from https://github.com/xlp0/PersonalKnowledgeContainer to https://github.com/xlp0/PKC. For the current implementation of Github, these two git repository names point to the same source. When GitHub change this practice, it will change. We recommend you to use the shorter version.
 
=References=
<References/>
 
[PersonalKnowledgeContainer]: https://github.com/xlp0/PersonalKnowledgeContainer
[container-virtualization]:https://searchitoperations.techtarget.com/definition/container-containerization-or-container-based-virtualization
[command line]:https://www.osc.edu/supercomputing/unix-cmds
[terminal]: https://www.techopedia.com/definition/28747/mac-terminal-mac-os-x#:~:text=The%20Mac%20Terminal%20is%20a,OS%20X%20versions%20through%20Lion.&text=Terminal%20allows%20users%20to%20modify,graphical%20user%20interface%20(GUI).
[PKC]: https://github.com/xlp0/PersonalKnowledgeContainer
[VirtualBox PKC]: https://github.com/xlp0/VirtualBox_PKC
[cd]:https://www.minitool.com/news/how-to-change-directory-in-cmd.html
[microservice]: https://www.bmc.com/blogs/microservices-architecture/
[Docker]: http://docker.io
[MediaWiki]: https://www.mediawiki.org/wiki/MediaWiki
[Main Page]: http://localhost:9352/index.php/Main_Page
[WSL]: https://docs.docker.com/docker-for-windows/wsl/
[up.sh]:https://github.com/xlp0/PKC/blob/main/up.sh
[git]:https://git-scm.com/
[Git Installation]:https://git-scm.com/
[Git Bash]: https://gitforwindows.org/
[git clone]:https://www.atlassian.com/git/tutorials/setting-up-a-repository/git-clone#:~:text=git%20clone%20is%20a%20Git,copy%20of%20the%20target%20repository.

Latest revision as of 10:33, 7 July 2023

Personal Knowledge Container(Q110762241)/(個人知識容器) is a way to help attain personalized data sovereignty through Personal Cloud technologies. It can also be used as Public Knowledge Container and/or Project Knowledge Container.It is abbreviated as PKC[1][2][3], is a collection of micro services (computation and communication processes) that enables personalized ownership of Hyperlink-centric data asset[4]. It is a tool designed to be operated by individuals or communities of varying sizes and can be deployed to network environments of your choice. After the installation, your local instance of PKC service on your own computer will work, even without access to the Internet. PKC allows for an integrative deployment of user-friendly knowledge presentation, extensible functionalities, and self-servicing data asset ownership in a single package. In other words, this technology platform is designed to lower the entry barrier for the ownership of self-sovereign data assets.

The abstract specification of PKC

It will be helpful to read the Abstract Specification of PKC before continuing.


Logic Model (PKC) Template:LogicModel 07 7, 2023
Abstract Specification
Context Given the impacts of Moore's Law, by year 2020, most Internet-connected data can be universally abstracted as a set of services, files, and page data assets, individuals can manage a scalable collection of data assets on privately owned computing resources and connect their resources to the public Internet at will. At the same time, software tools created under the Free Software movement, such as MediaWiki, Semantic MediaWiki[5],[6], Solid, Docker, Kubernetes, and Ansible[7] have matured to a point that allows for individual persons to own personally controlled data centers. This created a new asset class that can have significant technological and societal implications.
Goal To offer personal data asset management at scale PKC aims at minimizing the operational complexity of data backup, verification, and restore process as a sound data validation workflow, while using public-key infrastructure and networked timestamps to ensure the trust-worthiness of PKC contained data.
Success Criteria
  1. Allow Individual users to install an instance of MediaWiki service by reading this PKC/Readme.md file.
  2. Make all textual content, executable software images, installation scripts in the public domain, so that everyone can share and use them at will.
  3. Provide instructions to learn about how to use PKC in the initial MediaWiki's database, so that people can start learning to use PKC through their own instance of MediaWiki.
Concrete Implementation
Given Inputs When Process is executed... Then, we get Outputs
  1. A computer that you have access to its "root" or "administrator" previledge.
  2. A host machine that runs an Operatng System that supports Docker:
    1. Windows 10
    2. Mac OS X
    3. Linux
  3. Access to the Internet during intallation time. Try to perform the installation on a network with 10Mbps+ to the Internet.
    1. After installation, this system can operated without access to the Internet.
    2. References to MediaWiki's software installation practices[8].


 Go to Main Text
  1. Install Git
  2. Install Docker Runtime
  3. Install PKC
  4. (optional) Install Reverse Proxy
  5. (Optional) Example of Source Code
  1. A localized instance of Personal Knowledge Container, which can be accessed on localhost.
  2. Given a configurable regular interval, all the changes you made to your local instance of MediaWiki will be automatically backed up to the directory's "backup/" sub-directory.
  3. The textual content stored in MediaWiki's database can will be stored in an XML file: XLPLATEST.xml
  4. All the uploaded files, assuming the file names are accepted by the host operating system, will be dumped to the "backup/MediaFile/" sub-directory.
  5. New applications and data processing patterns can be defined by Data Flow
  6. Please carefully read Explaining LocalSettings.php to see how the MediaWiki is being set up.
Boundary/Safety Conditions of PKC
  1. PKC have only been tested on a small number of machines and configurations, your mileage may vary.
    1. Compared to Unix-derivatives such as Mac OSX and Linux operating systems, installing PKC on Windows operating system can be a challenge, therefore, please refer to PKC on Windows Platform.
  2. We can not warrant any reliability, completeness, and accuracy of this installation procedure. Any action you take upon this information and execute this script is at your own risk, the software developers for PKC have no way to be liable for any losses and damages in connection to the use of the actions and software prescribed here.
  3. Do not remove any of the files in the directory with backup/, such as docker-compose.yml and the LocalSettings.php. These files are the configuration files for Docker and MediaWiki respectively. Missing them, this system will cease to work.


Context

To help manage personalized and project-based data asset, PKC is designed to run in scalable configurations, starting from personalized computing resources, up to multi-server cloud environments. The overall approach of PKC is try to minimize the entry-barrier of automated workflow and create an inclusive field of growth driven by Moore's Law. The system design work of PKC will try to follow principles presented in the book: Specifying Systems[9].

Goal

Create a basic set of services, files, and page content to help individuals operate a MediaWiki website on any machine of their choosing. This will allow them to continuously work with their own data assets, independent of future changes.

Success Criteria

  1. Allow Individuals to install an instance of MediaWiki service by reading this PKC/Readme.md file.
  2. Make all textual content, executable software images, installation scripts in the public domain, so that everyone can share and use them at will.
  3. Provide instructions to learn about how to use PKC in the initial MediaWiki's database, so that people can start learning to use PKC through their own instance of MediaWiki.

Required Resources

  1. A computer[10] that you have access to its "root" or "administrator" previledge.
  2. Operatng Systems that support Docker: Windows 10, Mac OS X Big Sur 11.2.3 and Linux.
  3. Under Windows 10 Environment, some VPN software might interfere with Docker's Windows Subsystem for Linux, a.k.a. Windows Subsystem for Linux (WSL), you will need to remove VPN software before installing [Docker]. In case you don't want to remvoe your VPN software, or your Docker and Bash have compatibility issues, please try to [VirtualBox PKC] solution.
  4. Access to the Internet during intallation time. Please try to perform the installation on a network with 10Mbps+ to the Internet. After installation, this system can operated without access to the Internet.
  5. Relevant software implementation examples and architectural patterns in the field of Knowledge Management

Installation Procedure/Implementation Process

  1. Installation must be conducted by a person who possess the root password of the target machine. When it starts installing, root password needs to be provided in a command line interface (CLI).
  2. You will need Git, the software installed on your machine. You may follow the instructions on Git Software Installation and Download.
  3. Install Docker, the Installation instructions and downloadable files can be found here: https://docs.docker.com/get-started/
  4. After the success of Docker installation, launch a terminal application, or often called command line interface (CLI)interface, move your working directory using the command cd", meaning change your working directory, to a directory in your file system. For Mac OS X and Linux operating systems, Terminal applications are bundled during installation. For Windows 10 PKC Installation, please refer to this page.

Assume the directory you keep your working files is called: Workspace, your terminal application/command line interface (CLI) should present a prompt, similar to the following format: (your environment might also display machine name and user name along with the working directory name) 

 ~/userName/Workspace$

Download the entire package using git. You may copy the instruction as follows: 

 ~/userName/Workspace$ git clone https://github.com/xlp0/PKC.git
  1. After the git clone instruction copied relevant data to your working directory, using the command cd to the PKC directory that contains the script up.sh, and type: ./up.sh to execute the script.(If you are running Windows machine, just type:.\up.bat or just up.)
 ~/userName/Workspace$ cd PKC
 ~/userName/Workspace/PKC$ ./up.sh
  1. After you submitted the ./up.sh in your command line interface, you will be asked for a password, type in the root password for the machine you are trying to install.
  2. Depends on your network connection, this process will download around 5GB of data, so that it will take a while.
  3. Open a browser: type the following URL to the browser's URL field: http://localhost:9352.
  4. In case you need to have administrator access, use Admin as user name, and metalanguage as password.
  5. If you plan to set up https for your PKC, please refer to the page:Nginx as Reverse Proxy.

Expected Outcome

  1. Every 30 minutes, all the changes you made to your local instance of MediaWiki will be automatically backed up to the directory's "backup/" sub-directory.
  2. The textual content stored in MediaWiki's database can will be stored in an XML file: XLPLATEST.xml
  3. All the uploaded files, assuming the file names are accepted by the host operating system, will be dumped to the "backup/MediaFile/" sub-directory.
  4. New applications and data processing patterns can be defined by PageFlow

Boundary Conditions

  1. We can not warrant any reliability, completeness, and accuracy of this installation procedure. Any action you take upon this information and execute this script is at your own risk, We will not be liable for any losses and damages in connection to the use of the actions and software prescribed here.
  2. We have only tested on a small number of machines and configurations, your mileage may vary.
  3. Do not remove any of the files in the directory with backup/, such as docker-compose.yml and the LocalSettings.php. These files are the configuration files for Docker and MediaWiki respectively. Missing them, this system will cease to work.
  4. Many pre-defined parameters can be replaced in the .env file stored in the PKC directory. It allows flexible configuration of your system. For more information, please read Configure your own PKC instance.
  5. For the sake of reducing typos, the project has moved from https://github.com/xlp0/PersonalKnowledgeContainer to https://github.com/xlp0/PKC. For the current implementation of Github, these two git repository names point to the same source. When GitHub change this practice, it will change. We recommend you to use the shorter version.


Slide Show

For a slide show on PKC, please see this following slide set: 

{{#widget:Google Presentation|docid= 18ZArxRn0FuQPLcAIkXeNxOsZFyrnLR1ncdkqTm6TqVk |size=medium}}

References

  1. ↑ PKC (Github Project, URL: https://github.com/xlp0/PKC
  2. ↑ Benkler, Yochai (Apr 22, 2008). Yochai Benkler: Open-source economics. local page: TED. 
  3. ↑ Encyclosphere. (2022, April 6). PKC Media Wiki, . Retrieved 03:24, April 26, 2022 from https://www.pkc.pub/index.php?title=Encyclosphere&oldid=29070.
  4. ↑ https://www.bmc.com/blogs/microservices-architecture/
  5. ↑ Skaf-Molli, Hala; Canals, G ́erˆome; Molli, Pascal (2010). DSMW: Distributed Semantic MediaWiki (PDF). Part II. Berlin Heidelberg: Springer-Verlag. p. 26–430. 
  6. ↑ Koren, Yaron (2020). Working with MediaWiki (2nd ed.). local page: WikiWorks Press. ISBN 978-1540761149. 
  7. ↑ https://www.mediawiki.org/wiki/Meza
  8. ↑ MediaWiki Manual:Installation Guide. local page: WikiMedia. Jan 8, 2022. 
  9. ↑ Lamport, Leslie (2020). Specifying Systems: The TLA+ Language and Tools for Hardware and Software Engineers. local page: Addison Wesley. ISBN 0-321-14306-X. 
  10. ↑ Delaney, Jeff (Jan 15, 2021). Raspberry Pi versus AWS // How to host your website on the RPi4. local page: Fireship. 

Related Pages

Start datetime= 11 24, 2024


Retrieved from "https://pkc.pub/index.php?title=Personal_Knowledge_Container&oldid=39363"