diff options
author | Lars Wirzenius <liw@liw.fi> | 2018-09-10 11:58:14 +0300 |
---|---|---|
committer | Lars Wirzenius <liw@liw.fi> | 2018-09-10 11:58:14 +0300 |
commit | 8ed563a828fad9bb5a61232d4e76eceb4644427e (patch) | |
tree | 78696506261c18cd8c4e46d97a7413232a055a60 /newuser.mdwn | |
parent | d45a64885d6700005e06619dcc69b826f469a8eb (diff) | |
download | ick.liw.fi-8ed563a828fad9bb5a61232d4e76eceb4644427e.tar.gz |
Add: new demo ick user welcome page
Diffstat (limited to 'newuser.mdwn')
-rw-r--r-- | newuser.mdwn | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/newuser.mdwn b/newuser.mdwn new file mode 100644 index 0000000..5531e50 --- /dev/null +++ b/newuser.mdwn @@ -0,0 +1,88 @@ +[[!meta title="New user of demo ick site"]] + +Hello, and welcome. + +I've set up a demo instance of ick, and created an account for you. +This page has instructions for using it. Thank you for helping me with +ick. + +Ick is ALPHA level software, and keeps changing. Sorry about that. As +part of process, the way ick is accessed is currently changing. +Everything in this page is likely to change in the coming weeks. Be +prepared to learn new things, although we will try to avoid breaking +things. + +I will have communicated your username and password privately to you. +To start using ick, you need to create a couple of configuration +files. + +* Create the file `~/.config/icktool/icktool.yaml`: + + config: + controller: https://demo-controller.vm.liw.fi + +* Create `~/.config/icktool/credentials.conf`: + + [https://demo-controller.vm.liw.fi/token] + client_id = USERNAME + client_secret = PASSWORD + +After this, the following should work: + + icktool status + +You can also log in via the rudimentary, ugly web application: +<https://demo-controller.vm.liw.fi/web>. Note that we're about to +start work on a much nicer web application, which will have a +different URL. + +With icktool, you can create projects and pipeline, and trigger +builds, as if as an admin, on the demo instance. There are currently +two workers, which are Hetzner cx11 VMs, so quite feeble: 1 vCPU, 2 GB +RAM. + +I've seeded the demo instance with a couple of projects and pipelines: +http://git.liw.fi/liw-ci/tree/demo.ick (you can copy that and feed it +to icktool make-it-so; that git repo has all my .ick files). The +`stretch_systree` project builds an artifact that has stretch with +`build-essential` installed. You should be able to use this as the +systree for any builds you do. Please be careful about running any +actions that are NOT in a container. Running things in a container is +"safe", running things on the host may break the worker host. + +There is an APT repository +(<http://demo-controller.vm.liw.fi/debian>), and you can configure +your projects in ick to build Debian packages and have them uploaded +to the APT repository. Note that the APT repository is public, anyone +can download from it. See <https://ick.liw.fi/> website for +instructions and examples. + +There are at this time no limitations on the licenses of software +built on the ick demo site. However, please don't put anything there +you're not allowed to distribute publicly. + +Warning: Several people have accounts on the demo instance. There is +currently no real safety or security between ick users. You can modify +or delete anyone else's project specification, download their build +artifacts, etc. This will be fixed at some point. Until then, I'm +trying to give access only to trustworthy people, like yourself. Be +careful, try to not mess with other people's stuff. (We are working on +making ick users safe and secure from each other.) + +Warning: I can't guarantee any level of service. + +Warning: The site gets updated automatically, whenever I make changes +to ick. I hope this won't break anything. There may be no announcement +before changes. Please follow the ick communications channels to know +what's going on. + +The demo service is free of charge. I may some day want to set up a +commercially hosted ick instance, but that'll happen much later on, if +ever. + +I ask you be kind, and report any problems you experience. Also, +please report any minor blemishes, such as typos, confusing language, +etc. + +And of course, patches are always welcome, but not expected. +Constructive criticism of the demo service is all I ask for. |