README.md 6.02 KB
Newer Older
1
2
3
TYPO3 CMS
=========

4
5
[![Build Status](https://travis-ci.org/TYPO3/TYPO3.CMS.svg?branch=master)](https://travis-ci.org/TYPO3/TYPO3.CMS)

6
TYPO3 is an open source PHP based web content management system released
7
under the GNU GPL. TYPO3 is copyright (c) 1999-2018 by Kasper Skaarhoj.
8
9
10
11
12
13

This document provides a basic introduction to TYPO3.

Getting Started
---------------

14
TYPO3 requires a web server with PHP and a database (e.g. MySQL).
15
16
Accessing the backend through a supported browser.

17
18
Please see the [Installation Guide](https://docs.typo3.org/typo3cms/InstallationGuide/) 
in order to set up a basic TYPO3 installation on your web server.
19
20
21
22

What is TYPO3?
--------------

23
24
25
26
TYPO3 is a free and open source Content Management Framework. It is
released under the GNU General Public License. It can run on several web
servers, such as Apache, nginx or IIS, on top of many operating systems,
among them Linux, Microsoft Windows, FreeBSD or MacOS.
27

28
29
30
TYPO3 was initially authored by Kasper Skårhøj and is now further
developed by a community of contributors and the [TYPO3 Core Development
Team](https://typo3.org/community/teams/typo3-development/).
31
32
33
34
35
36
37

To get more info about the GPL license, visit
http://www.opensource.org/licenses/gpl-license.php

What is a Content Management Framework?
---------------------------------------

38
39
40
41
A Content Management Framework is more than just a content management
system, due to the separation of the streamlined core and optional
plugins (extensions). TYPO3 has an open API that allows you to extend
the frontend (web site) and/or backend (administration) functionality.
42

43
44
45
The concept of extensions makes TYPO3 capable of being developed and
used in almost any way you can imagine, either by using any of the many
extensions which are available for download, or by writing your own.
46
47

TYPO3 System requirements
48
-------------------------
49

50
51
TYPO3 is based upon PHP and uses a database management system like
MySQL.
52

53
54
For more specific information regarding requirements see the
[INSTALL.md](INSTALL.md#server-system-requirements) file in this folder.
55
56
57
58

TYPO3 resources
---------------

59
60
Here is an overview of the most important TYPO3 resources to help you
get started:
61
62
63

### Get more information

64
65
* https://typo3.org is the main project website. It provides up to date
  official news, information about events, access to downloading the
66
67
  products and extensions.

68
* https://docs.typo3.org/: TYPO3 is one of the most thoroughly
69
  documented OpenSource products around, with manuals covering basic
70
71
72
73
74
75
76
77
78
  tutorials, TypoScript, administration, development, core structure,
  etc. You should make the time to locate the various documents, and
  read those that apply to the work you want to do.

* https://get.typo3.org/ is the platform where you can download TYPO3
  and find all release notes and change logs of TYPO3 releases.

* https://extensions.typo3.org/ is the platform where you can search for
  and download TYPO3 extensions.
79

80
81
### Chat with us

82
83
84
85
The TYPO3 community is using a tool called Slack to openly communicate
with each other and with the public. Several TYPO3 teams use Slack as a
way to communicate internally and most channels are a welcome place for
you to join and get yourself involved.
86
87
88
89

* Register: https://forger.typo3.org/slack/
* Slack: https://typo3.slack.com/

90
91
92
### Exchange information, ask questions, get help

Slack is nice for short discussions, but when asking questions, most
93
94
95
96
97
98
99
100
101
answers are lost in the noise after a few minutes.

#### StackOverflow

**To let everyone profit from an answer, we recommend to ask questions
on StackOverflow**. If you like, you can then post a link into the
corresponding Slack channel to raise attention. And please, do not
forget to tag your questions correctly with `typo3` (and possibly other
tags like `typo3-9.5.x`, `Fluid` or `Extbase`).
102
103

* [StackOverflow questions tagged "TYPO3"](https://stackoverflow.com/questions/tagged/typo3)
104

105
#### Official meet the TYPO3 Community overview:
106

107
Visit https://typo3.org/community/meet/
108

109
110
Contributing
------------
111

112
If you want to contribute to the TYPO3 source code, take a look at our
113
Contributors Walkthrough and Review System:
114

115
* https://docs.typo3.org/typo3cms/ContributionWorkflowGuide/
116
* https://review.typo3.org/
117

118
119
120
121
122
> Please use the [TYPO3 Slack chat](#chat-with-us), if you need help in
> setting up your contribution environment. The community is very
> helpful and get you up and running! (Please post your questions in
> Slack Channel `#typo3-cms-coredev` regarding contribution support)

123
The [repository at GitHub](https://github.com/TYPO3/TYPO3.CMS) is a
124
synchronized mirror of the primary TYPO3 core git repository:
125
126
127

* https://git.typo3.org/Packages/TYPO3.CMS.git

128
If you want to file a bug report, take a look at:
129

130
* [https://forge.typo3.org](https://forge.typo3.org/projects/typo3cms-core/issues)
131
132
133
134
135

Final notes
-----------

TYPO3 is said to be one of the most sophisticated PHP / Internet related
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
applications available, and the more you play with it, the more you will
agree.

Due to the advanced level of the code and functionality, a degree of
study, time and perseverance is required to fully understand it, and get
the best from it. You should keep trying, as we say it's definitely
worth it. TYPO3 is the Enterprise Content Management System "for all".

The GPL license allows for developments that are based upon TYPO3 to
also be freely available under the GPL. Please remember this, because
TYPO3 is about "Inspiring People To Share". If you are making money with
TYPO3 you can donate or become a member of the TYPO3 Association.

By becoming a supporting member, individuals and organisations mainly
fund core development of TYPO3. The decision about what the funds are
used for, is made by all members of the Association and the Expert
Advisory Board (EAB). The decisions will be made transparent to the
community and especially the supporting members. Your funds will also
serve for other purposes as laid out in the bylaws.
155

156
* Donate: https://typo3.org/donate
157
* Become a member of the TYPO3 Association:
158
  https://typo3.org/project/association/
159
160
161
162
163

Copyleft
--------

This document is a part of the TYPO3 project.