summaryrefslogtreecommitdiff
path: root/newuser.mdwn
blob: 2788568034bda6f46affdaec2e884cedd2bd9d0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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 that 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.