File: app-createuser.html

package info (click to toggle)
mpsql 2.1-2
links: PTS
area: non-free
in suites: potato
size: 3,528 kB
ctags: 4,886
sloc: ansic: 35,184; makefile: 3,761; sh: 44
file content (535 lines) | stat: -rw-r--r-- 8,246 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML
><HEAD
><TITLE
>createuser</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet version 1.19"><LINK
REL="HOME"
TITLE="PostgreSQL User's Guide"
HREF="user.html"><LINK
REL="UP"
TITLE="Utility Applications"
HREF="utilities.html"><LINK
REL="PREVIOUS"
TITLE="createdb"
HREF="app-createdb.html"><LINK
REL="NEXT"
TITLE="destroydb"
HREF="app-destroydb.html"></HEAD
><BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PostgreSQL User's Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="app-createdb.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="app-destroydb.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><SPAN
CLASS="APPLICATION"
>createuser</SPAN
></H1
><DIV
CLASS="REFNAMEDIV"
><H2
>Name</H2
><SPAN
CLASS="APPLICATION"
>createuser</SPAN
> &#8212; Create a new <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> user</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><PRE
CLASS="SYNOPSIS"
>createuser [ <TT
CLASS="REPLACEABLE"
><I
>username</I
></TT
> ]
createuser [ -h <TT
CLASS="REPLACEABLE"
><I
>host</I
></TT
> ] [ -p <TT
CLASS="REPLACEABLE"
><I
>port</I
></TT
> ]
    [ -i <TT
CLASS="REPLACEABLE"
><I
>userid</I
></TT
> ]
    [ -d | -D ] [ -u | -U ] [ <TT
CLASS="REPLACEABLE"
><I
>username</I
></TT
> ]</PRE
><DIV
CLASS="REFSECT2"
><H3
>Inputs</H3
><P
>&#13;<P
></P
></P><DL
><DT
>-h <TT
CLASS="REPLACEABLE"
><I
>host</I
></TT
></DT
><DD
><P
>Specifies the hostname of the machine on which the 
<SPAN
CLASS="APPLICATION"
>postmaster</SPAN
>
is running.  Defaults to using a local Unix domain socket
 rather than an IP connection..&#13;</P
></DD
><DT
>-p <TT
CLASS="REPLACEABLE"
><I
>port</I
></TT
></DT
><DD
><P
>Specifies the Internet TCP/IP port or local Unix domain socket file 
extension on which the <SPAN
CLASS="APPLICATION"
>postmaster</SPAN
>
is listening for connections.  The port number defaults to 5432,
 or the value of the <TT
CLASS="ENVAR"
>PGPORT</TT
>
environment variable (if set).&#13;</P
></DD
><DT
>-d</DT
><DD
><P
>Allows the user to create databases.&#13;</P
></DD
><DT
>-D</DT
><DD
><P
>Forbids the user to create databases.&#13;</P
></DD
><DT
>-i <TT
CLASS="REPLACEABLE"
><I
>userid</I
></TT
></DT
><DD
><P
>Specifies the numeric identifier to be associated with this user.
This identifier must be unique among all <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> users, and is not required
to match the operating system UID.
You will be prompted for an identifier if none is specified on the command line,
and it will suggest an identifier matching the UID.&#13;</P
></DD
><DT
>-u</DT
><DD
><P
>Allows the user to create other users.&#13;</P
></DD
><DT
>-U</DT
><DD
><P
>Forbids the user to create other users.&#13;</P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>username</I
></TT
></DT
><DD
><P
>Specifies the name of the <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> user to be created. 
This name must be unique among all <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> users.
You will be prompted for a name if none is specified on the command line.&#13;</P
></DD
></DL
><P>&#13;</P
></DIV
><DIV
CLASS="REFSECT2"
><H3
>Outputs</H3
><P
><SPAN
CLASS="APPLICATION"
>createuser</SPAN
> will add an entry in the
<TT
CLASS="LITERAL"
>pg_user</TT
> or <TT
CLASS="LITERAL"
>pg_shadow</TT
> system table.

<P
></P
></P><DL
><DT
>Connection to database 'template1' failed.
connectDB() failed: Is the postmaster running and accepting connections
 at 'UNIX Socket' on port '<TT
CLASS="REPLACEABLE"
><I
>port</I
></TT
>'?
createuser: database access failed.</DT
><DD
><P
><SPAN
CLASS="APPLICATION"
>createuser</SPAN
> could not attach to the 
<SPAN
CLASS="APPLICATION"
>postmaster</SPAN
> 
process on the specified host and port.  If you see this message,
ensure that the <SPAN
CLASS="APPLICATION"
>postmaster</SPAN
> 
is running on the proper host and that you have specified the proper
port.  If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.&#13;</P
></DD
><DT
>Connection to database 'template1' failed.
FATAL 1:  SetUserId: user '<TT
CLASS="REPLACEABLE"
><I
>username</I
></TT
>' is not in 'pg_shadow'
createuser: database access failed.</DT
><DD
><P
>You do not have a valid entry in the relation <TT
CLASS="LITERAL"
>pg_shadow</TT
>
and and will not be allowed to access <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
>. Contact your
<SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> administrator.&#13;</P
></DD
><DT
>createuser: <TT
CLASS="REPLACEABLE"
><I
>username</I
></TT
> cannot create users.</DT
><DD
><P
>You do not have permission to create new users; contact your
<SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> site administrator.&#13;</P
></DD
><DT
>createuser: user "<TT
CLASS="REPLACEABLE"
><I
>username</I
></TT
>" already exists</DT
><DD
><P
>The user to be added already has an entry in the <TT
CLASS="LITERAL"
>pg_shadow</TT
>
class.&#13;</P
></DD
><DT
>database access failed</DT
><DD
><P
>An internal error occurred in <SPAN
CLASS="APPLICATION"
>psql</SPAN
>
or in the backend server.  Ensure that your site administrator has
properly installed <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
>and initialized the site with 
<SPAN
CLASS="APPLICATION"
>initdb</SPAN
>.&#13;</P
></DD
></DL
><P>

<BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
><SPAN
CLASS="APPLICATION"
>createuser</SPAN
> internally runs
CREATE USER from <SPAN
CLASS="APPLICATION"
>psql</SPAN
>
while connected to the <TT
CLASS="LITERAL"
>template1</TT
> database.</P
></BLOCKQUOTE
>&#13;</P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><H2
>Description</H2
><P
><SPAN
CLASS="APPLICATION"
>createuser</SPAN
> creates a 
new <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> user.  
Only users with <TT
CLASS="LITERAL"
>usesuper</TT
> set in
the <TT
CLASS="LITERAL"
>pg_shadow</TT
> class can create 
new <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> users.  As shipped,
the user <TT
CLASS="LITERAL"
>postgres</TT
> can create users.&#13;</P
><P
><SPAN
CLASS="APPLICATION"
>createuser</SPAN
> is a shell script that invokes
<SPAN
CLASS="APPLICATION"
>psql</SPAN
>.
Hence, a <SPAN
CLASS="APPLICATION"
>postmaster</SPAN
>
process must be running on the database server host before
<SPAN
CLASS="APPLICATION"
>createuser</SPAN
> is executed.
 The 
<TT
CLASS="ENVAR"
>PGOPTION</TT
>
and
<TT
CLASS="ENVAR"
>PGREALM</TT
>
environment variables will be passed on to
<SPAN
CLASS="APPLICATION"
>psql</SPAN
>
and processed as described in <A
HREF="app-psql.html"
><I
><I
>psql</I
></I
></A
>.

Once invoked, <SPAN
CLASS="APPLICATION"
>createuser</SPAN
>
will ask a series of questions to obtain parameters not specified on
the command line.  The new user's database login name and a numeric 
user identifier must be specified.

<BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>The <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> user identifier
does not need to be the same as the user's Unix UID. However, typically
they are assigned to be the same.</P
></BLOCKQUOTE
>&#13;</P
><P
>You must also describe the privileges of the new user for security purposes.
Specifically, you will be asked whether the new user should be able to
act as <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> super-user,
whether the new user may create new databases and whether the new user
is allowed to create other new users.&#13;</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="app-createdb.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="user.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="app-destroydb.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><SPAN
CLASS="APPLICATION"
>createdb</SPAN
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="utilities.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><SPAN
CLASS="APPLICATION"
>destroydb</SPAN
></TD
></TR
></TABLE
></DIV
></BODY
></HTML
>